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, 5 insertions, 5 deletions

diff --git a/include/gzip.h b/include/gzip.h
index cb4db3d70f..e578b283ed 100644
--- a/include/gzip.h
+++ b/include/gzip.h
@@ -16,7 +16,7 @@ struct blk_desc;
  *
  * @src: Pointer to gzip file
  * @len: Length of data
- * @return length of header in bytes, or -1 if not enough data
+ * Return: length of header in bytes, or -1 if not enough data
  */
 int gzip_parse_header(const unsigned char *src, unsigned long len);
 
@@ -27,7 +27,7 @@ int gzip_parse_header(const unsigned char *src, unsigned long len);
  * @dstlen: Size of destination buffer
  * @src: Source data to decompress
  * @lenp: Returns length of uncompressed data
- * @return 0 if OK, -1 on error
+ * Return: 0 if OK, -1 on error
  */
 int gunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp);
 
@@ -40,7 +40,7 @@ int gunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp);
  * @lenp: On entry, length data at @src. On exit, number of bytes used from @src
  * @stoponerr: 0 to continue when a decode error is found, 1 to stop
  * @offset: start offset within the src buffer
- * @return 0 if OK, -1 on error
+ * Return: 0 if OK, -1 on error
  */
 int zunzip(void *dst, int dstlen, unsigned char *src, unsigned long *lenp,
 	   int stoponerr, int offset);
@@ -71,7 +71,7 @@ void gzwrite_progress_finish(int retcode, ulong totalwritten, ulong totalsize,
  * @startoffs:	offset in bytes of first write
  * @szexpected:	expected uncompressed length, may be zero to use gzip trailer
  *		for files under 4GiB
- * @return 0 if OK, -1 on error
+ * Return: 0 if OK, -1 on error
  */
 int gzwrite(unsigned char *src, int len, struct blk_desc *dev, ulong szwritebuf,
 	    ulong startoffs, ulong szexpected);
@@ -84,7 +84,7 @@ int gzwrite(unsigned char *src, int len, struct blk_desc *dev, ulong szwritebuf,
  *	number of bytes used in the buffer
  * @src: Source data to compress
  * @srclen: Size of source data
- * @return 0 if OK, -1 on error
+ * Return: 0 if OK, -1 on error
  */
 int gzip(void *dst, unsigned long *lenp, unsigned char *src, ulong srclen);