linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-arm-kernel@lists.infradead.org,
	linux-kernel@vger.kernel.org,
	Andrey Smirnov <andrew.smirnov@gmail.com>
Subject: [PATCH 08/10] mfd: si476x-i2c: Add description for si476x_core_fwver_to_revision()'s arg 'func'
Date: Thu, 25 Jun 2020 17:31:25 +0100	[thread overview]
Message-ID: <20200625163127.4000462-9-lee.jones@linaro.org> (raw)
In-Reply-To: <20200625163127.4000462-1-lee.jones@linaro.org>

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 | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/drivers/mfd/si476x-i2c.c b/drivers/mfd/si476x-i2c.c
index c8d28b844def8..517d49bcd667b 100644
--- a/drivers/mfd/si476x-i2c.c
+++ b/drivers/mfd/si476x-i2c.c
@@ -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
-- 
2.25.1


  parent reply	other threads:[~2020-06-25 16:32 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-06-25 16:31 [PATCH 00/10] Fix a yet more W=1 warnings in MFD Lee Jones
2020-06-25 16:31 ` [PATCH 01/10] mfd: cros_ec_dev: Fix cros_feature_to_{name,cells} struct descriptions Lee Jones
2020-06-25 16:35   ` Enric Balletbo i Serra
2020-06-25 16:31 ` [PATCH 02/10] mfd: tps65218: Repair incorrect function argument name 's/tps65218/tps/' Lee Jones
2020-06-25 16:31 ` [PATCH 03/10] mfd: tps65217: Repair incorrect function argument name 's/tps65217/tps/' Lee Jones
2020-06-25 16:31 ` [PATCH 04/10] mfd: ab3100-otp: Add missing colon(s) for all documented kerneldoc arguments Lee Jones
2020-07-07 12:40   ` Linus Walleij
2020-06-25 16:31 ` [PATCH 05/10] mfd: tps65010: Remove delcared and set, but never used variable 'status' Lee Jones
2020-06-25 16:31 ` [PATCH 06/10] mfd: si476x-cmd: Repair wrongly described function argument 's/response/resp' Lee Jones
2020-06-25 16:31 ` [PATCH 07/10] mfd: si476x-cmd: Add missing colon(s) for all documented kerneldoc arguments Lee Jones
2020-06-25 16:31 ` Lee Jones [this message]
2020-06-25 16:31 ` [PATCH 09/10] mfd: si476x-i2c: Fix spelling mistake in case() statement's FALLTHROUGH comment Lee Jones
2020-06-25 16:31 ` [PATCH 10/10] mfd: si476x-cmd: Update si476x_cmd_am_rsq_status()'s kerneldoc Lee Jones

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200625163127.4000462-9-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=andrew.smirnov@gmail.com \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).