mfd: si476x-cmd: Add missing documentation for si476x_cmd_fm_rds_status()'s arg ...
authorLee Jones <lee.jones@linaro.org>
Wed, 24 Jun 2020 13:29:18 +0000 (14:29 +0100)
committerLee Jones <lee.jones@linaro.org>
Mon, 6 Jul 2020 07:32:04 +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-cmd.c:907: warning: Function parameter or member 'report' not described in 'si476x_core_cmd_fm_rds_status'

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

index 0a40c5c..d15b3e7 100644 (file)
@@ -892,6 +892,8 @@ EXPORT_SYMBOL_GPL(si476x_core_cmd_fm_seek_start);
  *                rest RDS data contains the last valid info received
  * @mtfifo: if set the command clears RDS receive FIFO
  * @intack: if set the command clards the RDSINT bit.
+ * @report: - all signal quality information retured by the command
+ *           (if NULL then the output of the command is ignored)
  *
  * Function returns 0 on success and negative error code on failure
  */