aboutsummaryrefslogtreecommitdiffstats
path: root/include/linux/usb.h
diff options
context:
space:
mode:
authorYacine Belkadi <yacine.belkadi.1@gmail.com>2013-08-02 14:10:04 -0400
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>2013-08-02 23:30:14 -0400
commit626f090c5cbbe557379978c7a9525011ad7fbbf6 (patch)
treea79ab527b8c1f21067d8d5126b029917bc0b838c /include/linux/usb.h
parent6b0a1cf732f917f2eaccb4a0dd6ae7bfc3ccda15 (diff)
usb: fix some scripts/kernel-doc warnings
When building the htmldocs (in verbose mode), scripts/kernel-doc reports the following type of warnings: Warning(drivers/usb/core/usb.c:76): No description found for return value of 'usb_find_alt_setting' Fix them by: - adding some missing descriptions of return values - using "Return" sections for those descriptions Signed-off-by: Yacine Belkadi <yacine.belkadi.1@gmail.com> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'include/linux/usb.h')
-rw-r--r--include/linux/usb.h12
1 files changed, 8 insertions, 4 deletions
diff --git a/include/linux/usb.h b/include/linux/usb.h
index 6efdab089014..acb1b0aa77d8 100644
--- a/include/linux/usb.h
+++ b/include/linux/usb.h
@@ -708,7 +708,10 @@ extern int usb_driver_claim_interface(struct usb_driver *driver,
708 * usb_interface_claimed - returns true iff an interface is claimed 708 * usb_interface_claimed - returns true iff an interface is claimed
709 * @iface: the interface being checked 709 * @iface: the interface being checked
710 * 710 *
711 * Returns true (nonzero) iff the interface is claimed, else false (zero). 711 * Return: %true (nonzero) iff the interface is claimed, else %false
712 * (zero).
713 *
714 * Note:
712 * Callers must own the driver model's usb bus readlock. So driver 715 * Callers must own the driver model's usb bus readlock. So driver
713 * probe() entries don't need extra locking, but other call contexts 716 * probe() entries don't need extra locking, but other call contexts
714 * may need to explicitly claim that lock. 717 * may need to explicitly claim that lock.
@@ -745,8 +748,9 @@ extern struct usb_host_interface *usb_find_alt_setting(
745 * @buf: where to put the string 748 * @buf: where to put the string
746 * @size: how big is "buf"? 749 * @size: how big is "buf"?
747 * 750 *
748 * Returns length of the string (> 0) or negative if size was too small. 751 * Return: Length of the string (> 0) or negative if size was too small.
749 * 752 *
753 * Note:
750 * This identifier is intended to be "stable", reflecting physical paths in 754 * This identifier is intended to be "stable", reflecting physical paths in
751 * hardware such as physical bus addresses for host controllers or ports on 755 * hardware such as physical bus addresses for host controllers or ports on
752 * USB hubs. That makes it stay the same until systems are physically 756 * USB hubs. That makes it stay the same until systems are physically
@@ -1578,7 +1582,7 @@ extern int usb_anchor_empty(struct usb_anchor *anchor);
1578 * usb_urb_dir_in - check if an URB describes an IN transfer 1582 * usb_urb_dir_in - check if an URB describes an IN transfer
1579 * @urb: URB to be checked 1583 * @urb: URB to be checked
1580 * 1584 *
1581 * Returns 1 if @urb describes an IN transfer (device-to-host), 1585 * Return: 1 if @urb describes an IN transfer (device-to-host),
1582 * otherwise 0. 1586 * otherwise 0.
1583 */ 1587 */
1584static inline int usb_urb_dir_in(struct urb *urb) 1588static inline int usb_urb_dir_in(struct urb *urb)
@@ -1590,7 +1594,7 @@ static inline int usb_urb_dir_in(struct urb *urb)
1590 * usb_urb_dir_out - check if an URB describes an OUT transfer 1594 * usb_urb_dir_out - check if an URB describes an OUT transfer
1591 * @urb: URB to be checked 1595 * @urb: URB to be checked
1592 * 1596 *
1593 * Returns 1 if @urb describes an OUT transfer (host-to-device), 1597 * Return: 1 if @urb describes an OUT transfer (host-to-device),
1594 * otherwise 0. 1598 * otherwise 0.
1595 */ 1599 */
1596static inline int usb_urb_dir_out(struct urb *urb) 1600static inline int usb_urb_dir_out(struct urb *urb)