From: Lee Jones <lee.jones@linaro.org>
To: broonie@kernel.org, lgirdwood@gmail.com
Cc: linux-arm-kernel@lists.infradead.org,
linux-kernel@vger.kernel.org, Lee Jones <lee.jones@linaro.org>,
patches@opensource.cirrus.com
Subject: [PATCH 8/9] regulator: wm8400-regulator: Repair dodgy kerneldoc header formatting
Date: Fri, 26 Jun 2020 07:57:37 +0100 [thread overview]
Message-ID: <20200626065738.93412-9-lee.jones@linaro.org> (raw)
In-Reply-To: <20200626065738.93412-1-lee.jones@linaro.org>
W=1 kernel builds report a lack of descriptions for various
function arguments. In reality they are documented, but the
formatting was not as expected '@.*:'. Instead, some weird
arg identifiers were used.
This change fixes the following warnings:
drivers/regulator/wm8400-regulator.c:243: warning: Function parameter or member 'dev' not described in 'wm8400_register_regulator'
drivers/regulator/wm8400-regulator.c:243: warning: Function parameter or member 'reg' not described in 'wm8400_register_regulator'
drivers/regulator/wm8400-regulator.c:243: warning: Function parameter or member 'initdata' not described in 'wm8400_register_regulator'
Cc: patches@opensource.cirrus.com
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
drivers/regulator/wm8400-regulator.c | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/drivers/regulator/wm8400-regulator.c b/drivers/regulator/wm8400-regulator.c
index 4cb1fbb597227..e9fd137077213 100644
--- a/drivers/regulator/wm8400-regulator.c
+++ b/drivers/regulator/wm8400-regulator.c
@@ -234,9 +234,9 @@ static struct platform_driver wm8400_regulator_driver = {
* the regulator API. It is intended to be called from the
* platform_init() callback of the WM8400 MFD driver.
*
- * @param dev The WM8400 device to operate on.
- * @param reg The regulator to control.
- * @param initdata Regulator initdata for the regulator.
+ * @dev: The WM8400 device to operate on.
+ * @reg: The regulator to control.
+ * @initdata: Regulator initdata for the regulator.
*/
int wm8400_register_regulator(struct device *dev, int reg,
struct regulator_init_data *initdata)
--
2.25.1
next prev parent reply other threads:[~2020-06-26 6:58 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-26 6:57 [PATCH 0/9] Fix a bunch more W=1 warnings in Regulator Lee Jones
2020-06-26 6:57 ` [PATCH 1/9] regulator: max8998: Staticify internal function max8998_get_current_limit() Lee Jones
2020-06-26 6:57 ` [PATCH 2/9] regulator: qcom-rpmh-regulator: Repair dodgy kerneldoc header formatting Lee Jones
2020-06-26 7:18 ` Bjorn Andersson
2020-06-26 6:57 ` [PATCH 3/9] regulator: pwm-regulator: Demote kerneldoc header to standard comment Lee Jones
2020-06-26 6:57 ` [PATCH 4/9] regulator: stpmic1_regulator: Properly document 'struct stpmic1_regulator_cfg' Lee Jones
2020-06-26 6:57 ` [PATCH 5/9] regulator: tps65217-regulator: Remove pointless 'is unsigned int <0' check Lee Jones
2020-06-26 6:57 ` [PATCH 6/9] regulator: tps65217-regulator: Use the returned value of tps65217_reg_read() Lee Jones
2020-06-26 13:33 ` Mark Brown
2020-06-26 15:31 ` Lee Jones
2020-06-26 15:34 ` Mark Brown
2020-06-26 6:57 ` [PATCH 7/9] regulator: tps65218-regulator: Remove pointless 'is unsigned int <0' check Lee Jones
2020-06-26 6:57 ` Lee Jones [this message]
2020-06-26 9:20 ` [PATCH 8/9] regulator: wm8400-regulator: Repair dodgy kerneldoc header formatting Charles Keepax
2020-06-26 6:57 ` [PATCH 9/9] regulator: qcom_smd-regulator: Remove unused 'struct regulator_desc pmi8994_boost' Lee Jones
2020-06-26 7:19 ` Bjorn Andersson
2020-06-26 15:21 ` [PATCH 0/9] Fix a bunch more W=1 warnings in Regulator Mark Brown
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=20200626065738.93412-9-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=broonie@kernel.org \
--cc=lgirdwood@gmail.com \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=patches@opensource.cirrus.com \
/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®