diff options
author | Heinrich Schuchardt | 2022-01-19 18:05:50 +0100 |
---|---|---|
committer | Heinrich Schuchardt | 2022-01-19 18:11:34 +0100 |
commit | 185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch) | |
tree | 2fea02768d6005934547f075586c60ba7aca6253 /include/spi_flash.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 'include/spi_flash.h')
-rw-r--r-- | include/spi_flash.h | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/include/spi_flash.h b/include/spi_flash.h index 4566feab631..d33d0dd46ad 100644 --- a/include/spi_flash.h +++ b/include/spi_flash.h @@ -47,7 +47,7 @@ struct dm_spi_flash_ops { * @offset: Offset into device in bytes to read from * @len: Number of bytes to read * @buf: Buffer to put the data that is read - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int spi_flash_read_dm(struct udevice *dev, u32 offset, size_t len, void *buf); @@ -58,7 +58,7 @@ int spi_flash_read_dm(struct udevice *dev, u32 offset, size_t len, void *buf); * @offset: Offset into device in bytes to write to * @len: Number of bytes to write * @buf: Buffer containing bytes to write - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int spi_flash_write_dm(struct udevice *dev, u32 offset, size_t len, const void *buf); @@ -71,7 +71,7 @@ int spi_flash_write_dm(struct udevice *dev, u32 offset, size_t len, * @dev: SPI flash device * @offset: Offset into device in bytes to start erasing * @len: Number of bytes to erase - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int spi_flash_erase_dm(struct udevice *dev, u32 offset, size_t len); @@ -83,7 +83,7 @@ int spi_flash_erase_dm(struct udevice *dev, u32 offset, size_t len); * defined. * * @dev: SPI flash device - * @return 0 if no region is write-protected, 1 if a region is + * Return: 0 if no region is write-protected, 1 if a region is * write-protected, -ENOSYS if the driver does not implement this, * other -ve value on error */ @@ -97,7 +97,7 @@ int spl_flash_get_sw_write_prot(struct udevice *dev); * do this, typically with of-platdata * * @dev: SPI-flash device to probe - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error */ int spi_flash_std_probe(struct udevice *dev); |