mfd: si476x-i2c: Add description for si476x_core_fwver_to_revision()'s arg 'func'
authorLee Jones <lee.jones@linaro.org>
Wed, 24 Jun 2020 13:32:06 +0000 (14:32 +0100)
committerLee Jones <lee.jones@linaro.org>
Mon, 6 Jul 2020 07:32:03 +0000 (08:32 +0100)
Kerneldoc syntax is used, but not complete.

Descriptions are required for all arguments.

Fixes the following W=1 build warning:

 drivers/mfd/si476x-i2c.c:550: warning: Function parameter or member 'func' not described in 'si476x_core_fwver_to_revision'

Cc: Andrey Smirnov <andrew.smirnov@gmail.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
drivers/mfd/si476x-i2c.c

index c8d28b8..517d49b 100644 (file)
@@ -534,6 +534,11 @@ static irqreturn_t si476x_core_interrupt(int irq, void *dev)
 /**
  * si476x_firmware_version_to_revision()
  * @core: Core device structure
+ * @func: Selects the boot function of the device:
+ *         *_BOOTLOADER  - Boot loader
+ *         *_FM_RECEIVER - FM receiver
+ *         *_AM_RECEIVER - AM receiver
+ *         *_WB_RECEIVER - Weatherband receiver
  * @major:  Firmware major number
  * @minor1: Firmware first minor number
  * @minor2: Firmware second minor number