Re: [PATCH 1/3] usb: add kerneldoc for usb_get_hub_child_device function

[Sergei Shtylyov <sshtylyov@xxxxxxxxxx>]

Hello.

On 05/14/2012 05:14 PM, Lan Tianyu wrote:

> Signed-off-by: Lan Tianyu<tianyu.lan@xxxxxxxxx>
> ---
>   drivers/usb/core/hub.c |   11 +++++++++++
>   1 files changed, 11 insertions(+), 0 deletions(-)

> diff --git a/drivers/usb/core/hub.c b/drivers/usb/core/hub.c
> index 6bf7124..cbd9f13 100644
> --- a/drivers/usb/core/hub.c
> +++ b/drivers/usb/core/hub.c
> @@ -4236,6 +4236,17 @@ void usb_queue_reset_device(struct usb_interface *iface)
>   }
>   EXPORT_SYMBOL_GPL(usb_queue_reset_device);
>
> +/**
> + * usb_get_hub_childe_device - Get the pointer of child device

   s/childe/child/

> + * attached to the port which is specified by param port1.
> + *
> + * @param hdev: USB device belonging to the usb hub

   "param" is not needed, just "@hdev:". See 
Documentation/kernel-doc-nano-HOWTO.txt.

> + * @param port1: port num to indicate which port the child device
> + *	is attached to.
> + *
> + * @return: NULL if input param is invalid.

   This would be treated as a parameter having name 'return'. There's no format 
for function return value.

WBR, Sergei
--
To unsubscribe from this list: send the line "unsubscribe linux-usb" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html