diff options
author | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2022-01-19 18:05:50 +0100 |
---|---|---|
committer | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2022-01-19 18:11:34 +0100 |
commit | 185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch) | |
tree | 2fea02768d6005934547f075586c60ba7aca6253 /arch/sandbox/include/asm/gpio.h | |
parent | 6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff) |
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 'arch/sandbox/include/asm/gpio.h')
-rw-r--r-- | arch/sandbox/include/asm/gpio.h | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/arch/sandbox/include/asm/gpio.h b/arch/sandbox/include/asm/gpio.h index 9542fdee67..0dd4c7bf60 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 @@ int sandbox_gpio_get_value(struct udevice *dev, unsigned int offset); * @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 @@ int sandbox_gpio_set_value(struct udevice *dev, unsigned int offset, int value); * * @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 @@ int sandbox_gpio_get_direction(struct udevice *dev, unsigned int offset); * @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 @@ int sandbox_gpio_set_direction(struct udevice *dev, unsigned int offset, * * @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 @@ ulong sandbox_gpio_get_flags(struct udevice *dev, unsigned int offset); * @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); |