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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]


On 2012/5/14 21:51, Felipe Balbi wrote:
On Mon, May 14, 2012 at 09:49:53PM +0800, Lan Tianyu wrote:
hi felipe:
             Thanks for your review.
On 2012/5/14 21:23, Felipe Balbi wrote:
On Mon, May 14, 2012 at 09:14:26PM +0800, 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
                   ^^^^^^
		  child
         Good catching.
+ * attached to the port which is specified by param port1.
                                                        ^^^^^
						       @port1
+ *
+ * @param hdev: USB device belonging to the usb hub
       ^^^^^^^^^^^
       @hdev
                 This is produced by doxymacs. I also found some
that's not kerneldoc, right ? :-) See
Documentation/kernel-doc-nano-HOWTO.txt
Oh. Great. I just look for a standard. :)
Thanks to point out. I will update soon.

places in the
    kernel also use the same way.  I must follow "@xxx"? since my following
    patches also have used "@param xxx:".
yeah, I think you should fix other patches too.



--
Best Regards
Tianyu Lan
linux kernel enabling team

--
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


B and H Foto and Electronics Corp.

[Linux Media]     [Video for Linux]     [Linux Input]     [Linux Audio Users]     [Photo]     [Yosemite News]    [Yosemite Photos]    [Free Online Dating]     [Linux Kernel]     [Linux SCSI]     [Old Linux USB Devel Archive]     [More Archives]

Add to Google Powered by Linux