summaryrefslogtreecommitdiff
path: root/include/usb_ether.h
diff options
context:
space:
mode:
authorHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-01-19 20:05:50 +0300
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-01-19 20:11:34 +0300
commit185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch)
tree2fea02768d6005934547f075586c60ba7aca6253 /include/usb_ether.h
parent6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff)
downloadu-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.tar.xz
doc: replace @return by Return:
Sphinx expects Return: and not @return to indicate a return value. find . -name '*.c' -exec \ sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \; find . -name '*.h' -exec \ sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \; Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Diffstat (limited to 'include/usb_ether.h')
-rw-r--r--include/usb_ether.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/include/usb_ether.h b/include/usb_ether.h
index e85acadb7f..8c7bd06906 100644
--- a/include/usb_ether.h
+++ b/include/usb_ether.h
@@ -43,7 +43,7 @@ struct ueth_data {
* @dev: USB device
* @ss: Place to put USB ethernet data
* @rxsize: Maximum size to allocate for the receive buffer
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int usb_ether_register(struct udevice *dev, struct ueth_data *ueth, int rxsize);
@@ -51,7 +51,7 @@ int usb_ether_register(struct udevice *dev, struct ueth_data *ueth, int rxsize);
* usb_ether_deregister() - deregister a USB ethernet device
*
* @ueth: USB Ethernet device
- * @return 0
+ * Return: 0
*/
int usb_ether_deregister(struct ueth_data *ueth);
@@ -62,7 +62,7 @@ int usb_ether_deregister(struct ueth_data *ueth);
*
* @ueth: USB Ethernet device
* @rxsize: Maximum size to receive
- * @return 0 if a packet was received, -EAGAIN if not, -ENOSPC if @rxsize is
+ * Return: 0 if a packet was received, -EAGAIN if not, -ENOSPC if @rxsize is
* larger than the size passed ot usb_ether_register(), other -ve on error
*/
int usb_ether_receive(struct ueth_data *ueth, int rxsize);
@@ -77,7 +77,7 @@ int usb_ether_receive(struct ueth_data *ueth, int rxsize);
* @ueth: USB Ethernet device
* @ptrp: Returns a pointer to the start of the next packet if there is
* one available
- * @return number of bytes available, or 0 if none
+ * Return: number of bytes available, or 0 if none
*/
int usb_ether_get_rx_bytes(struct ueth_data *ueth, uint8_t **ptrp);