usb/typec: fix kernel-doc notation warning for typec_match_altmode

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: 8a37d87d72 ("usb: typec: Bus type for alternate modes")

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Heikki Krogerus <heikki.krogerus@linux.intel.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Randy Dunlap 2018-09-03 12:58:35 -07:00 committed by Greg Kroah-Hartman
parent f3dc41c5d2
commit 40de5fe4f4
1 changed files with 4 additions and 3 deletions

View File

@ -255,12 +255,13 @@ EXPORT_SYMBOL_GPL(typec_altmode_unregister_driver);
/* API for the port drivers */ /* 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 * @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 * @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. * match is found.
*/ */
struct typec_altmode *typec_match_altmode(struct typec_altmode **altmodes, struct typec_altmode *typec_match_altmode(struct typec_altmode **altmodes,