From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-arm-kernel@lists.infradead.org,
linux-kernel@vger.kernel.org,
Linus Walleij <linus.walleij@linaro.org>
Subject: [PATCH 04/10] mfd: ab3100-otp: Add missing colon(s) for all documented kerneldoc arguments
Date: Thu, 25 Jun 2020 17:31:21 +0100 [thread overview]
Message-ID: <20200625163127.4000462-5-lee.jones@linaro.org> (raw)
In-Reply-To: <20200625163127.4000462-1-lee.jones@linaro.org>
Kerneldoc validation gets confused if syntax isn't "@.*: ".
Adding the missing colons squashes the following W=1 warnings:
drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'dev' not described in 'ab3100_otp'
drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'locked' not described in 'ab3100_otp'
drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'freq' not described in 'ab3100_otp'
drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'paf' not described in 'ab3100_otp'
drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'imeich' not described in 'ab3100_otp'
drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'cid' not described in 'ab3100_otp'
drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'tac' not described in 'ab3100_otp'
drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'fac' not described in 'ab3100_otp'
drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'svn' not described in 'ab3100_otp'
drivers/mfd/ab3100-otp.c:60: warning: Function parameter or member 'debugfs' not described in 'ab3100_otp'
Cc: Linus Walleij <linus.walleij@linaro.org>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
drivers/mfd/ab3100-otp.c | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/drivers/mfd/ab3100-otp.c b/drivers/mfd/ab3100-otp.c
index c4751fb9bc224..c393102e3a394 100644
--- a/drivers/mfd/ab3100-otp.c
+++ b/drivers/mfd/ab3100-otp.c
@@ -29,22 +29,22 @@
/**
* struct ab3100_otp
- * @dev containing device
- * @locked whether the OTP is locked, after locking, no more bits
+ * @dev: containing device
+ * @locked: whether the OTP is locked, after locking, no more bits
* can be changed but before locking it is still possible
* to change bits from 1->0.
- * @freq clocking frequency for the OTP, this frequency is either
+ * @freq: clocking frequency for the OTP, this frequency is either
* 32768Hz or 1MHz/30
- * @paf product activation flag, indicates whether this is a real
+ * @paf: product activation flag, indicates whether this is a real
* product (paf true) or a lab board etc (paf false)
- * @imeich if this is set it is possible to override the
+ * @imeich: if this is set it is possible to override the
* IMEI number found in the tac, fac and svn fields with
* (secured) software
- * @cid customer ID
- * @tac type allocation code of the IMEI
- * @fac final assembly code of the IMEI
- * @svn software version number of the IMEI
- * @debugfs a debugfs file used when dumping to file
+ * @cid: customer ID
+ * @tac: type allocation code of the IMEI
+ * @fac: final assembly code of the IMEI
+ * @svn: software version number of the IMEI
+ * @debugfs: a debugfs file used when dumping to file
*/
struct ab3100_otp {
struct device *dev;
--
2.25.1
next prev 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 ` Lee Jones [this message]
2020-07-07 12:40 ` [PATCH 04/10] mfd: ab3100-otp: Add missing colon(s) for all documented kerneldoc arguments 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 ` [PATCH 08/10] mfd: si476x-i2c: Add description for si476x_core_fwver_to_revision()'s arg 'func' Lee Jones
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-5-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=linus.walleij@linaro.org \
--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
all inboxes | Powered by JetHome®