From 185f812c419f1b4f0d10d9787d59cf9f11a2a600 Mon Sep 17 00:00:00 2001
From: Heinrich Schuchardt
Date: Wed, 19 Jan 2022 18:05:50 +0100
Subject: 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>
---
 include/net/dsa.h  |  8 ++++----
 include/net/pcap.h | 12 ++++++------
 2 files changed, 10 insertions(+), 10 deletions(-)

(limited to 'include/net')

diff --git a/include/net/dsa.h b/include/net/dsa.h
index 1b1068cd88c..9fa9d4e7853 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 512ba982f10..6184bf53a8a 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);
-- 
cgit v1.2.3