From: Heikki Krogerus <heikki.krogerus@linux.intel.com>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: LKML <linux-kernel@vger.kernel.org>,
USB list <linux-usb@vger.kernel.org>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Subject: usb/typec: fix kernel-doc notation warning for typec_match_altmode
Date: Tue, 4 Sep 2018 10:38:37 +0300 [thread overview]
Message-ID: <20180904073837.GF15112@kuha.fi.intel.com> (raw)
On Mon, Sep 03, 2018 at 12:58:35PM -0700, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@infradead.org>
>
> Fix kernel-doc warning for missing function parameter 'mode' description:
>
> ../drivers/usb/typec/bus.c:268: warning: Function parameter or member 'mode' not described in 'typec_match_altmode'
>
> Also fix typos for same function documentation.
>
> Fixes: 8a37d87d72f0 ("usb: typec: Bus type for alternate modes")
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Heikki Krogerus <heikki.krogerus@linux.intel.com>
Acked-by: Heikki Krogerus <heikki.krogerus@linux.intel.com>
> ---
> drivers/usb/typec/bus.c | 7 ++++---
> 1 file changed, 4 insertions(+), 3 deletions(-)
>
> --- lnx-419-rc2.orig/drivers/usb/typec/bus.c
> +++ lnx-419-rc2/drivers/usb/typec/bus.c
> @@ -255,12 +255,13 @@ EXPORT_SYMBOL_GPL(typec_altmode_unregist
> /* API for the port drivers */
>
> /**
> - * typec_match_altmode - Match SVID to an array of alternate modes
> + * typec_match_altmode - Match SVID and mode to an array of alternate modes
> * @altmodes: Array of alternate modes
> - * @n: Number of elements in the array, or -1 for NULL termiated arrays
> + * @n: Number of elements in the array, or -1 for NULL terminated arrays
> * @svid: Standard or Vendor ID to match with
> + * @mode: Mode to match with
> *
> - * Return pointer to an alternate mode with SVID mathing @svid, or NULL when no
> + * Return pointer to an alternate mode with SVID matching @svid, or NULL when no
> * match is found.
> */
> struct typec_altmode *typec_match_altmode(struct typec_altmode **altmodes,
next reply other threads:[~2018-09-04 7:38 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-09-04 7:38 Heikki Krogerus [this message]
-- strict thread matches above, loose matches on Subject: below --
2018-09-03 19:58 usb/typec: fix kernel-doc notation warning for typec_match_altmode Randy Dunlap
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=20180904073837.GF15112@kuha.fi.intel.com \
--to=heikki.krogerus@linux.intel.com \
--cc=gregkh@linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-usb@vger.kernel.org \
--cc=rdunlap@infradead.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).