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>

tools/fit_common.h

@@ -16,7 +16,7 @@
  * @ptr: image header to be verified
  * @image_size: size of while image
  * @params: mkimage parameters
- * @return 0 if OK, -1 on error
+ * Return: 0 if OK, -1 on error
  */
 int fit_verify_header(unsigned char *ptr, int image_size,
 			struct image_tool_params *params);
@@ -33,7 +33,7 @@ int fit_check_image_types(uint8_t type);
  * @sbuf:	File status information is stored here
  * @delete_on_error:	true to delete the file if we get an error
  * @read_only:	true to open in read-only mode
- * @return 0 if OK, -1 on error.
+ * Return: 0 if OK, -1 on error.
  */
 int mmap_fdt(const char *cmdname, const char *fname, size_t size_inc,
 	     void **blobp, struct stat *sbuf, bool delete_on_error,

tools/ifdtool.c

@@ -43,7 +43,7 @@ struct input_file {
  *
  * @image:	Pointer to image
  * @size:	Size of image in bytes
- * @return pointer to structure, or NULL if not found
+ * Return: pointer to structure, or NULL if not found
  */
 static struct fdbar_t *find_fd(char *image, int size)
 {
@@ -72,7 +72,7 @@ static struct fdbar_t *find_fd(char *image, int size)
  * @frba:		Flash region list
  * @region_type:	Type of region (0..MAX_REGIONS-1)
  * @region:		Region information is written here
- * @return 0 if OK, else -ve
+ * Return: 0 if OK, else -ve
  */
 static int get_region(struct frba_t *frba, int region_type,
 		      struct region_t *region)
@@ -380,7 +380,7 @@ static void dump_oem(uint8_t *oem)
  *
  * @image:	Pointer to image
  * @size:	Size of image in bytes
- * @return 0 if OK, -1 on error
+ * Return: 0 if OK, -1 on error
  */
 static int dump_fd(char *image, int size)
 {
@@ -432,7 +432,7 @@ static int dump_fd(char *image, int size)
  *
  * @image:	Pointer to image
  * @size:	Size of image in bytes
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 static int write_regions(char *image, int size)
 {
@@ -487,7 +487,7 @@ static int perror_fname(const char *fmt, const char *fname)
  * @filename:	Filename to use for the image
  * @image:	Pointer to image
  * @size:	Size of image in bytes
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 static int write_image(char *filename, char *image, int size)
 {
@@ -595,7 +595,7 @@ static void unlock_descriptor(char *image, int size)
  *
  * @fname:	Filename to open
  * @sizep:	Returns file size in bytes
- * @return 0 if OK, -1 on error
+ * Return: 0 if OK, -1 on error
  */
 int open_for_read(const char *fname, int *sizep)
 {
@@ -622,7 +622,7 @@ int open_for_read(const char *fname, int *sizep)
  * @size:		Size of image in bytes
  * @region_type:	Region where the file should be added
  * @region_fname:	Filename to add to the image
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int inject_region(char *image, int size, int region_type, char *region_fname)
 {
@@ -701,7 +701,7 @@ int inject_region(char *image, int size, int region_type, char *region_fname)
  * @write_fname:	Filename to add to the image
  * @offset_uboot_top:	Offset of the top of U-Boot
  * @offset_uboot_start:	Offset of the start of U-Boot
- * @return number of bytes written if OK, -ve on error
+ * Return: number of bytes written if OK, -ve on error
  */
 static int write_data(char *image, int size, unsigned int addr,
 		      const char *write_fname, int offset_uboot_top,
@@ -792,7 +792,7 @@ static void print_usage(const char *name)
  * @str:	String to split
  * @firstp:	Returns first string
  * @secondp:	Returns second string
- * @return 0 if OK, -ve if @str does not have a :
+ * Return: 0 if OK, -ve if @str does not have a :
  */
 static int get_two_words(const char *str, char **firstp, char **secondp)
 {

tools/image-host.c

@@ -55,7 +55,7 @@ static int fit_set_hash_value(void *fit, int noffset, uint8_t *value,
  * @noffset:	subnode offset
  * @data:	data to process
  * @size:	size of data in bytes
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
  */
 static int fit_image_process_hash(void *fit, const char *image_name,
 		int noffset, const void *data, size_t size)
@@ -209,7 +209,7 @@ static int fit_image_setup_sig(struct image_sign_info *info,
  * @comment:	Comment to add to signature nodes
  * @require_keys: Mark all keys as 'required'
  * @engine_id:	Engine to use for signing
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
  */
 static int fit_image_process_sig(const char *keydir, const char *keyfile,
 		void *keydest, void *fit, const char *image_name,

tools/imagetool.h

@@ -176,7 +176,7 @@ struct image_type_params *imagetool_get_type(int type);
  * supported image type. If verification is successful, this prints
  * the respective header.
  *
- * @return 0 on success, negative if input image format does not match with
+ * Return: 0 on success, negative if input image format does not match with
  * any of supported image types
  */
 int imagetool_verify_print_header(
@@ -195,7 +195,7 @@ int imagetool_verify_print_header(
  * @tparams: image type parameters
  * @params: mkimage parameters
  *
- * @return 0 on success, negative if input image format does not match with
+ * Return: 0 on success, negative if input image format does not match with
  * the given image type
  */
 int imagetool_verify_print_header_by_type(
@@ -229,7 +229,7 @@ int imagetool_save_subimage(
  *
  * @params:	mkimage parameters
  * @fname:	filename to check
- * @return size of file, or -ve value on error
+ * Return: size of file, or -ve value on error
  */
 int imagetool_get_filesize(struct image_tool_params *params, const char *fname);
 
@@ -243,7 +243,7 @@ int imagetool_get_filesize(struct image_tool_params *params, const char *fname);
  *
  * @cmdname:	command name
  * @fallback:	timestamp to use if SOURCE_DATE_EPOCH isn't set
- * @return timestamp based on SOURCE_DATE_EPOCH
+ * Return: timestamp based on SOURCE_DATE_EPOCH
  */
 time_t imagetool_get_source_date(
 	const char *cmdname,

tools/rkcommon.h

@@ -19,7 +19,7 @@ enum {
 /**
  * rkcommon_check_params() - check params
  *
- * @return 0 if OK, -1 if ERROR.
+ * Return: 0 if OK, -1 if ERROR.
  */
 int rkcommon_check_params(struct image_tool_params *params);
 
@@ -56,7 +56,7 @@ void rkcommon_set_header(void *buf,  struct stat *sbuf,  int ifd,
  *
  * @buf:	Pointer to the image file
  * @file_size:	Size of entire bootable image file (incl. all padding)
- * @return 0 if OK
+ * Return: 0 if OK
  */
 int rkcommon_verify_header(unsigned char *buf, int size,
 			   struct image_tool_params *params);
@@ -76,7 +76,7 @@ void rkcommon_print_header(const void *buf);
  * Some socs cannot disable the rc4-encryption of the spl binary.
  * rc4 encryption is disabled normally except on socs that cannot
  * handle unencrypted binaries.
- * @return true or false depending on rc4 being required.
+ * Return: true or false depending on rc4 being required.
  */
 bool rkcommon_need_rc4_spl(struct image_tool_params *params);
 
@@ -99,7 +99,7 @@ void rkcommon_rc4_encode_spl(void *buf, unsigned int offset, unsigned int size);
  * @tparams:    Pointer tot the image type structure (for setting
  *              the header and header_size)
  *
- * @return 0 (always)
+ * Return: 0 (always)
  */
 int rkcommon_vrec_header(struct image_tool_params *params,
 			 struct image_type_params *tparams);