summaryrefslogtreecommitdiff
path: root/include/net
diff options
context:
space:
mode:
authorHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-01-19 18:05:50 +0100
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-01-19 18:11:34 +0100
commit185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch)
tree2fea02768d6005934547f075586c60ba7aca6253 /include/net
parent6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff)
downloadu-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.tar.gz
u-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.tar.bz2
u-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.zip
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/net')
-rw-r--r--include/net/dsa.h8
-rw-r--r--include/net/pcap.h12
2 files changed, 10 insertions, 10 deletions
diff --git a/include/net/dsa.h b/include/net/dsa.h
index 1b1068cd88..9fa9d4e785 100644
--- a/include/net/dsa.h
+++ b/include/net/dsa.h
@@ -130,7 +130,7 @@ struct dsa_pdata {
* @tailroom: Size, in bytes, of tailroom needed for the DSA tag.
* Total headroom and tailroom size should not exceed
* DSA_MAX_OVR.
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int dsa_set_tagging(struct udevice *dev, ushort headroom, ushort tailroom);
@@ -142,7 +142,7 @@ int dsa_set_tagging(struct udevice *dev, ushort headroom, ushort tailroom);
* Can be called at driver probe time or later.
*
* @dev: DSA device pointer
- * @return Master Eth 'udevice' pointer if OK, NULL on error
+ * Return: Master Eth 'udevice' pointer if OK, NULL on error
*/
struct udevice *dsa_get_master(struct udevice *dev);
@@ -153,7 +153,7 @@ struct udevice *dsa_get_master(struct udevice *dev);
*
* @dev: DSA switch udevice pointer
* @port: Port index
- * @return OF node reference if OK, NULL on error
+ * Return: OF node reference if OK, NULL on error
*/
ofnode dsa_port_get_ofnode(struct udevice *dev, int port);
@@ -164,7 +164,7 @@ ofnode dsa_port_get_ofnode(struct udevice *dev, int port);
* Can be called at driver probe time or later.
*
* @pdev: DSA port device pointer
- * @return 'dsa_port_pdata' pointer if OK, NULL on error
+ * Return: 'dsa_port_pdata' pointer if OK, NULL on error
*/
static inline struct dsa_port_pdata *
dsa_port_get_pdata(struct udevice *pdev)
diff --git a/include/net/pcap.h b/include/net/pcap.h
index 512ba982f1..6184bf53a8 100644
--- a/include/net/pcap.h
+++ b/include/net/pcap.h
@@ -10,7 +10,7 @@
* @paddr physicaly memory address to store buffer
* @size maximum size of capture file in memory
*
- * @return 0 on success, -ERROR on error
+ * Return: 0 on success, -ERROR on error
*/
int pcap_init(phys_addr_t paddr, unsigned long size);
@@ -19,28 +19,28 @@ int pcap_init(phys_addr_t paddr, unsigned long size);
*
* @start if true, start capture if false stop capture
*
- * @return 0 on success, -ERROR on error
+ * Return: 0 on success, -ERROR on error
*/
int pcap_start_stop(bool start);
/**
* pcap_clear() - clear pcap capture buffer and statistics
*
- * @return 0 on success, -ERROR on error
+ * Return: 0 on success, -ERROR on error
*/
int pcap_clear(void);
/**
* pcap_print_status() - print status of pcap capture
*
- * @return 0 on success, -ERROR on error
+ * Return: 0 on success, -ERROR on error
*/
int pcap_print_status(void);
/**
* pcap_active() - check if pcap is enabled
*
- * @return TRUE if active, FALSE if not.
+ * Return: TRUE if active, FALSE if not.
*/
bool pcap_active(void);
@@ -50,6 +50,6 @@ bool pcap_active(void);
* @packet: packet to post
* @len: packet length in bytes
* @outgoing packet direction (outgoing/incoming)
- * @return 0 on success, -ERROR on error
+ * Return: 0 on success, -ERROR on error
*/
int pcap_post(const void *packet, size_t len, bool outgoing);