ata: libata: avoid kernel-doc warnings

Modify comments to prevent kernel-doc warnings:
- use "/*" for a non-kernel-doc comment
- add a Returns: section for ata_id_major_version()

Warning: include/linux/ata.h:770 Cannot find identifier on line:
 *
Warning: include/linux/ata.h:782 function parameter 'id' not described in 'ata_id_sct_data_tables'
Warning: include/linux/ata.h:782 expecting prototype for Word(). Prototype was for ata_id_sct_data_tables() instead
Warning: include/linux/ata.h:820 No description found for return value of 'ata_id_major_version'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Damien Le Moal <dlemoal@kernel.org>

diff --git a/include/linux/ata.h b/include/linux/ata.h
index 8fd48bcb2a46ce021dee041d9057ebb3217c3b9a..7daad4cad985a91c7f896ccc492f6ce7d0bfd40f 100644 (file)
--- a/include/linux/ata.h
+++ b/include/linux/ata.h
@@ -762,8 +762,7 @@ static inline bool ata_id_sense_reporting_enabled(const u16 *id)
        return id[ATA_ID_COMMAND_SET_4] & BIT(6);
 }
 
-/**
- *
+/*
  * Word: 206 - SCT Command Transport
  *    15:12 - Vendor Specific
  *     11:6 - Reserved
@@ -810,8 +809,9 @@ static inline bool ata_id_sct_supported(const u16 *id)
  *
  *     The practical impact of this is that ata_id_major_version cannot
  *     reliably report on drives below ATA3.
+ *
+ *     Returns: major version of ATA drive level or %0 if unknown
  */
-
 static inline unsigned int ata_id_major_version(const u16 *id)
 {
        unsigned int mver;