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>

scripts/dtc/libfdt/fdt_rw.c

@@ -123,7 +123,7 @@ static int fdt_splice_string_(void *fdt, int newlen)
  * @s: string to find/add
  * @allocated: Set to 0 if the string was found, 1 if not found and so
  *	allocated. Ignored if !fdt_chk_basic()
- * @return offset of string in the string table (whether found or added)
+ * Return: offset of string in the string table (whether found or added)
  */
 static int fdt_find_add_string_(void *fdt, const char *s, int *allocated)
 {

scripts/dtc/libfdt/libfdt.h

@@ -152,7 +152,7 @@ int fdt_next_node(const void *fdt, int offset, int *depth);
  *
  * @fdt:	FDT blob
  * @offset:	Offset of node to check
- * @return offset of first subnode, or -FDT_ERR_NOTFOUND if there is none
+ * Return: offset of first subnode, or -FDT_ERR_NOTFOUND if there is none
  */
 int fdt_first_subnode(const void *fdt, int offset);
 
@@ -164,7 +164,7 @@ int fdt_first_subnode(const void *fdt, int offset);
  *
  * @fdt:	FDT blob
  * @offset:	Offset of previous subnode
- * @return offset of next subnode, or -FDT_ERR_NOTFOUND if there are no more
+ * Return: offset of next subnode, or -FDT_ERR_NOTFOUND if there are no more
  * subnodes
  */
 int fdt_next_subnode(const void *fdt, int offset);

scripts/dtc/srcpos.c

@@ -66,7 +66,7 @@ static int srcfile_depth; /* = 0 */
  * @param dirname	Directory to look in, or NULL for none
  * @param fname		Filename to look for
  * @param fp		Set to NULL if file did not open
- * @return allocated filename on success (caller must free), NULL on failure
+ * Return: allocated filename on success (caller must free), NULL on failure
  */
 static char *try_open(const char *dirname, const char *fname, FILE **fp)
 {
@@ -93,7 +93,7 @@ static char *try_open(const char *dirname, const char *fname, FILE **fp)
  *
  * @param fname	Filename to open
  * @param fp	Returns pointer to opened FILE, or NULL on failure
- * @return pointer to allocated filename, which caller must free
+ * Return: pointer to allocated filename, which caller must free
  */
 static char *fopen_any_on_path(const char *fname, FILE **fp)
 {

scripts/dtc/srcpos.h

@@ -52,7 +52,7 @@ extern struct srcfile_state *current_srcfile; /* = NULL */
  * @param fullnamep	If non-NULL, it is set to the allocated filename of the
  *			file that was opened. The caller is then responsible
  *			for freeing the pointer.
- * @return pointer to opened FILE
+ * Return: pointer to opened FILE
  */
 FILE *srcfile_relative_open(const char *fname, char **fullnamep);
 

scripts/dtc/util.h

@@ -81,7 +81,7 @@ extern char *join_path(const char *path, const char *name);
  *
  * @param data	The string to check
  * @param len	The string length including terminator
- * @return 1 if a valid printable string, 0 if not
+ * Return: 1 if a valid printable string, 0 if not
  */
 bool util_is_printable_string(const void *data, int len);
 
@@ -98,7 +98,7 @@ char get_escape_char(const char *s, int *i);
  * stderr.
  *
  * @param filename	The filename to read, or - for stdin
- * @return Pointer to allocated buffer containing fdt, or NULL on error
+ * Return: Pointer to allocated buffer containing fdt, or NULL on error
  */
 char *utilfdt_read(const char *filename);
 
@@ -116,7 +116,7 @@ char *utilfdt_read_len(const char *filename, off_t *len);
  *
  * @param filename	The filename to read, or - for stdin
  * @param buffp		Returns pointer to buffer containing fdt
- * @return 0 if ok, else an errno value representing the error
+ * Return: 0 if ok, else an errno value representing the error
  */
 int utilfdt_read_err(const char *filename, char **buffp);
 
@@ -133,7 +133,7 @@ int utilfdt_read_err_len(const char *filename, char **buffp, off_t *len);
  *
  * @param filename	The filename to write, or - for stdout
  * @param blob		Poiner to buffer containing fdt
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
  */
 int utilfdt_write(const char *filename, const void *blob);
 
@@ -144,7 +144,7 @@ int utilfdt_write(const char *filename, const void *blob);
  *
  * @param filename	The filename to write, or - for stdout
  * @param blob		Poiner to buffer containing fdt
- * @return 0 if ok, else an errno value representing the error
+ * Return: 0 if ok, else an errno value representing the error
  */
 int utilfdt_write_err(const char *filename, const void *blob);
 
@@ -169,7 +169,7 @@ int utilfdt_write_err(const char *filename, const void *blob);
  * @param fmt		Format string to process
  * @param type		Returns type found(s/d/u/x), or 0 if none
  * @param size		Returns size found(1,2,4,8) or 4 if none
- * @return 0 if ok, -1 on error (no type given, or other invalid format)
+ * Return: 0 if ok, -1 on error (no type given, or other invalid format)
  */
 int utilfdt_decode_type(const char *fmt, int *type, int *size);