hwmon: prefix kernel-doc comments for structs with struct
authorLukas Bulwahn <lukas.bulwahn@gmail.com>
Thu, 16 Dec 2021 15:42:57 +0000 (16:42 +0100)
committerGuenter Roeck <linux@roeck-us.net>
Sun, 26 Dec 2021 23:02:06 +0000 (15:02 -0800)
commit130d168866a11829b844ffdb19b9aefe384f754c
tree468e745dfb0c1da0c4be28eb9c4d61ed969e0b96
parente13e979b2b3dafc9b5e7a4ec0ff17c875fedcf67
hwmon: prefix kernel-doc comments for structs with struct

The command ./scripts/kernel-doc -none include/linux/hwmon.h warns:

  include/linux/hwmon.h:406: warning: This comment starts with '/**', but
    isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
   * Channel information
  include/linux/hwmon.h:425: warning: This comment starts with '/**', but
    isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
   * Chip configuration

Address those kernel-doc warnings by prefixing kernel-doc descriptions for
structs with the keyword 'struct'.

Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Link: https://lore.kernel.org/r/20211216154257.26758-1-lukas.bulwahn@gmail.com
Signed-off-by: Guenter Roeck <linux@roeck-us.net>
include/linux/hwmon.h