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>

1 files changed, 11 insertions, 11 deletions

diff --git a/drivers/mtd/nand/raw/nand_util.c b/drivers/mtd/nand/raw/nand_util.c
index 5409c9f322..5150607d8a 100644
--- a/drivers/mtd/nand/raw/nand_util.c
+++ b/drivers/mtd/nand/raw/nand_util.c
@@ -47,7 +47,7 @@ typedef struct mtd_info		mtd_info_t;
  *
  * @param mtd		nand mtd instance to erase
  * @param opts		options,  @see struct nand_erase_options
- * @return		0 in case of success
+ * Return:		0 in case of success
  *
  * This code is ported from flash_eraseall.c from Linux mtd utils by
  * Arcom Control System Ltd.
@@ -202,7 +202,7 @@ int nand_erase_opts(struct mtd_info *mtd,
  * @param mtd		nand mtd instance
  * @param tight		bring device in lock tight mode
  *
- * @return		0 on success, -1 in case of error
+ * Return:		0 on success, -1 in case of error
  *
  * The lock / lock-tight command only applies to the whole chip. To get some
  * parts of the chip lock and others unlocked use the following sequence:
@@ -258,7 +258,7 @@ int nand_lock(struct mtd_info *mtd, int tight)
  * @param mtd		nand mtd instance
  * @param offset	page address to query (must be page-aligned!)
  *
- * @return		-1 in case of error
+ * Return:		-1 in case of error
  *			>0 lock status:
  *			  bitfield with the following combinations:
  *			  NAND_LOCK_STATUS_TIGHT: page in tight state
@@ -308,7 +308,7 @@ int nand_get_lock_status(struct mtd_info *mtd, loff_t offset)
  *			page size mtd->writesize)
  * @param allexcept	if set, unlock everything not selected
  *
- * @return		0 on success, -1 in case of error
+ * Return:		0 on success, -1 in case of error
  */
 int nand_unlock(struct mtd_info *mtd, loff_t start, size_t length,
 	int allexcept)
@@ -405,7 +405,7 @@ int nand_unlock(struct mtd_info *mtd, loff_t start, size_t length,
  * @param offset offset in flash
  * @param length image length
  * @param used length of flash needed for the requested length
- * @return 0 if the image fits and there are no bad blocks
+ * Return: 0 if the image fits and there are no bad blocks
  *         1 if the image fits, but there are bad blocks
  *        -1 if the image does not fit
  */
@@ -476,7 +476,7 @@ static size_t drop_ffs(const struct mtd_info *mtd, const u_char *buf,
  * @param mtd		nand mtd instance
  * @param ops		MTD operations, including data to verify
  * @param ofs		offset in flash
- * @return		0 in case of success
+ * Return:		0 in case of success
  */
 int nand_verify_page_oob(struct mtd_info *mtd, struct mtd_oob_ops *ops,
 			 loff_t ofs)
@@ -517,7 +517,7 @@ int nand_verify_page_oob(struct mtd_info *mtd, struct mtd_oob_ops *ops,
  * @param ofs		offset in flash
  * @param len		buffer length
  * @param buf		buffer to read from
- * @return		0 in case of success
+ * Return:		0 in case of success
  */
 int nand_verify(struct mtd_info *mtd, loff_t ofs, size_t len, u_char *buf)
 {
@@ -568,7 +568,7 @@ int nand_verify(struct mtd_info *mtd, loff_t ofs, size_t len, u_char *buf)
  *			exceed the buffer
  * @param buffer        buffer to read from
  * @param flags		flags modifying the behaviour of the write to NAND
- * @return		0 in case of success
+ * Return:		0 in case of success
  */
 int nand_write_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
 			size_t *actual, loff_t lim, u_char *buffer, int flags)
@@ -702,7 +702,7 @@ int nand_write_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
  * @param lim maximum size that actual may be in order to not exceed the
  * buffer
  * @param buffer buffer to write to
- * @return 0 in case of success
+ * Return: 0 in case of success
  */
 int nand_read_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
 		       size_t *actual, loff_t lim, u_char *buffer)
@@ -793,7 +793,7 @@ int nand_read_skip_bad(struct mtd_info *mtd, loff_t offset, size_t *length,
  * @param buf buffer to check
  * @param patt the pattern to check
  * @param size buffer size in bytes
- * @return 1 if there are only patt bytes in buf
+ * Return: 1 if there are only patt bytes in buf
  *         0 if something else was found
  */
 static int check_pattern(const u_char *buf, u_char patt, int size)
@@ -815,7 +815,7 @@ static int check_pattern(const u_char *buf, u_char patt, int size)
  *
  * @param mtd nand mtd instance
  * @param offset offset in flash
- * @return 0 if the block is still good
+ * Return: 0 if the block is still good
  */
 int nand_torture(struct mtd_info *mtd, loff_t offset)
 {