commit 47b4c025117482649ef7d5068e5070d4e2b5d65a
author Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Wed Jan 19 18:05:50 2022 +0100
committer Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Wed Jan 19 18:11:34 2022 +0100
tree 2fea02768d6005934547f075586c60ba7aca6253
parent 7ff76b46f110448032712b76b0272ac54805987e

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>

arch/sandbox/include/asm/gpio.h

diff --git a/arch/sandbox/include/asm/gpio.h b/arch/sandbox/include/asm/gpio.h
index 9542fde..0dd4c7b 100644
--- a/arch/sandbox/include/asm/gpio.h
+++ b/arch/sandbox/include/asm/gpio.h
@@ -37,7 +37,7 @@
  *
  * @param dev		device to use
  * @param offset	GPIO offset within bank
- * @return -1 on error, 0 if GPIO is low, >0 if high
+ * Return: -1 on error, 0 if GPIO is low, >0 if high
  */
 int sandbox_gpio_get_value(struct udevice *dev, unsigned int offset);
 
@@ -47,7 +47,7 @@
  * @param dev		device to use
  * @param offset	GPIO offset within bank
  * @param value		value to set (0 for low, non-zero for high)
- * @return -1 on error, 0 if ok
+ * Return: -1 on error, 0 if ok
  */
 int sandbox_gpio_set_value(struct udevice *dev, unsigned int offset, int value);
 
@@ -56,7 +56,7 @@
  *
  * @param dev		device to use
  * @param offset	GPIO offset within bank
- * @return -1 on error, 0 if GPIO is input, >0 if output
+ * Return: -1 on error, 0 if GPIO is input, >0 if output
  */
 int sandbox_gpio_get_direction(struct udevice *dev, unsigned int offset);
 
@@ -66,7 +66,7 @@
  * @param dev		device to use
  * @param offset	GPIO offset within bank
  * @param output	0 to set as input, 1 to set as output
- * @return -1 on error, 0 if ok
+ * Return: -1 on error, 0 if ok
  */
 int sandbox_gpio_set_direction(struct udevice *dev, unsigned int offset,
 			       int output);
@@ -76,7 +76,7 @@
  *
  * @param dev		device to use
  * @param offset	GPIO offset within bank
- * @return dir_flags: bitfield accesses by GPIOD_ defines
+ * Return: dir_flags: bitfield accesses by GPIOD_ defines
  */
 ulong sandbox_gpio_get_flags(struct udevice *dev, unsigned int offset);
 
@@ -86,7 +86,7 @@
  * @param dev		device to use
  * @param offset	GPIO offset within bank
  * @param flags		bitfield accesses by GPIOD_ defines
- * @return -1 on error, 0 if ok
+ * Return: -1 on error, 0 if ok
  */
 int sandbox_gpio_set_flags(struct udevice *dev, unsigned int offset,
 			   ulong flags);