Re: [PATCH 20/22] usb: typec_altmode: add a missing "@" at a kernel-doc parameter

[Heikki Krogerus]

On Tue, Jun 28, 2022 at 10:46:24AM +0100, Mauro Carvalho Chehab wrote:
> Without that, the parameter is not properly parsed:
> 	include/linux/usb/typec_altmode.h:132: warning: Function parameter or member 'altmode' not described in 'typec_altmode_get_orientation'
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab@xxxxxxxxxx>

Acked-by: Heikki Krogerus <heikki.krogerus@xxxxxxxxxxxxxxx>

> ---
> 
> To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
> See [PATCH 00/22] at: https://lore.kernel.org/all/cover.1656409369.git.mchehab@xxxxxxxxxx/
> 
>  include/linux/usb/typec_altmode.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/linux/usb/typec_altmode.h b/include/linux/usb/typec_altmode.h
> index 65933cbe9129..350d49012659 100644
> --- a/include/linux/usb/typec_altmode.h
> +++ b/include/linux/usb/typec_altmode.h
> @@ -124,7 +124,7 @@ struct typec_altmode *typec_match_altmode(struct typec_altmode **altmodes,
>  
>  /**
>   * typec_altmode_get_orientation - Get cable plug orientation
> - * altmode: Handle to the alternate mode
> + * @altmode: Handle to the alternate mode
>   */
>  static inline enum typec_orientation
>  typec_altmode_get_orientation(struct typec_altmode *altmode)
> -- 
> 2.36.1

-- 
heikki