From: Chanwoo Choi <cw00.choi@samsung.com>
To: Yang Li <yang.lee@linux.alibaba.com>, myungjoo.ham@samsung.com
Cc: linux-kernel@vger.kernel.org, Abaci Robot <abaci@linux.alibaba.com>
Subject: Re: [PATCH -next] extcon: Fix some kernel-doc comments
Date: Wed, 16 Feb 2022 10:26:47 +0900 [thread overview]
Message-ID: <2bde97d8-6575-0e0f-81bb-dd98f5b60607@samsung.com> (raw)
In-Reply-To: <20220104084359.41051-1-yang.lee@linux.alibaba.com>
On 1/4/22 5:43 PM, Yang Li wrote:
> Add the description of @id in extcon_sync() kernel-doc comment
> and @edev, @id, @prop in extcon_set_property_sync() kernel-doc
> comment to remove warnings found by running scripts/kernel-doc,
> which is caused by using 'make W=1'.
> drivers/extcon/extcon.c:409: warning: Function parameter or
> member 'id' not described in 'extcon_sync'
> drivers/extcon/extcon.c:750: warning: Function parameter or
> member 'edev' not described in 'extcon_set_property_sync'
> drivers/extcon/extcon.c:750: warning: Function parameter or
> member 'id' not described in 'extcon_set_property_sync'
> drivers/extcon/extcon.c:750: warning: Function parameter or
> member 'prop' not described in 'extcon_set_property_sync'
>
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
> ---
> drivers/extcon/extcon.c | 4 ++++
> 1 file changed, 4 insertions(+)
>
> diff --git a/drivers/extcon/extcon.c b/drivers/extcon/extcon.c
> index a09e704fd0fa..1e71ad489a83 100644
> --- a/drivers/extcon/extcon.c
> +++ b/drivers/extcon/extcon.c
> @@ -399,6 +399,7 @@ static ssize_t cable_state_show(struct device *dev,
> /**
> * extcon_sync() - Synchronize the state for an external connector.
> * @edev: the extcon device
> + * @id: the unique id indicating an external connector
> *
> * Note that this function send a notification in order to synchronize
> * the state and property of an external connector.
> @@ -736,6 +737,9 @@ EXPORT_SYMBOL_GPL(extcon_set_property);
>
> /**
> * extcon_set_property_sync() - Set property of an external connector with sync.
> + * @edev: the extcon device
> + * @id: the unique id indicating an external connector
> + * @prop: the property id indicating an extcon property
> * @prop_val: the pointer including the new value of extcon property
> *
> * Note that when setting the property value of external connector,
>
Applied it. Thanks.
--
Best Regards,
Chanwoo Choi
Samsung Electronics
prev parent reply other threads:[~2022-02-16 1:02 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <CGME20220104084415epcas1p3e904babe27a1a45ab66f3793fb68890d@epcas1p3.samsung.com>
2022-01-04 8:43 ` [PATCH -next] extcon: Fix some kernel-doc comments Yang Li
2022-02-16 1:26 ` Chanwoo Choi [this message]
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=2bde97d8-6575-0e0f-81bb-dd98f5b60607@samsung.com \
--to=cw00.choi@samsung.com \
--cc=abaci@linux.alibaba.com \
--cc=linux-kernel@vger.kernel.org \
--cc=myungjoo.ham@samsung.com \
--cc=yang.lee@linux.alibaba.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;
as well as URLs for NNTP newsgroup(s).