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 /include/pch.h | |
parent | 6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff) | |
download | u-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.zip u-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.tar.gz u-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.tar.bz2 |
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/pch.h')
-rw-r--r-- | include/pch.h | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/include/pch.h b/include/pch.h index 6205668..d2b6862 100644 --- a/include/pch.h +++ b/include/pch.h @@ -110,7 +110,7 @@ struct pch_ops { * * @dev: PCH device to check * @sbasep: Returns address of SPI base if available, else 0 - * @return 0 if OK, -ve on error (e.g. there is no SPI base) + * Return: 0 if OK, -ve on error (e.g. there is no SPI base) */ int pch_get_spi_base(struct udevice *dev, ulong *sbasep); @@ -120,7 +120,7 @@ int pch_get_spi_base(struct udevice *dev, ulong *sbasep); * @dev: PCH device to adjust * @protect: true to protect, false to unprotect * - * @return 0 on success, -ENOSYS if not implemented + * Return: 0 on success, -ENOSYS if not implemented */ int pch_set_spi_protect(struct udevice *dev, bool protect); @@ -129,7 +129,7 @@ int pch_set_spi_protect(struct udevice *dev, bool protect); * * @dev: PCH device to check * @gbasep: Returns address of GPIO base if available, else 0 - * @return 0 if OK, -ve on error (e.g. there is no GPIO base) + * Return: 0 if OK, -ve on error (e.g. there is no GPIO base) */ int pch_get_gpio_base(struct udevice *dev, u32 *gbasep); @@ -138,7 +138,7 @@ int pch_get_gpio_base(struct udevice *dev, u32 *gbasep); * * @dev: PCH device to check * @iobasep: Returns address of IO base if available, else 0 - * @return 0 if OK, -ve on error (e.g. there is no IO base) + * Return: 0 if OK, -ve on error (e.g. there is no IO base) */ int pch_get_io_base(struct udevice *dev, u32 *iobasep); @@ -154,7 +154,7 @@ int pch_get_io_base(struct udevice *dev, u32 *iobasep); * @req: PCH request ID * @data: Input/output data * @size: Size of input data (and maximum size of output data) - * @return size of output data on sucesss, -ve on error + * Return: size of output data on sucesss, -ve on error */ int pch_ioctl(struct udevice *dev, ulong req, void *data, int size); |