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

diff --git a/include/spl.h b/include/spl.h
index 0af0ee3003..9fc5ac61f8 100644
--- a/include/spl.h
+++ b/include/spl.h
@@ -106,7 +106,7 @@ enum u_boot_phase {
  *       ...
  *    }
  *
- * @return U-Boot phase
+ * Return: U-Boot phase
  */
 static inline enum u_boot_phase spl_phase(void)
 {
@@ -127,7 +127,7 @@ static inline enum u_boot_phase spl_phase(void)
 /**
  * spl_prev_phase() - Figure out the previous U-Boot phase
  *
- * @return the previous phase from this one, e.g. if called in SPL this returns
+ * Return: the previous phase from this one, e.g. if called in SPL this returns
  *	PHASE_TPL, if TPL is enabled
  */
 static inline enum u_boot_phase spl_prev_phase(void)
@@ -144,7 +144,7 @@ static inline enum u_boot_phase spl_prev_phase(void)
 /**
  * spl_next_phase() - Figure out the next U-Boot phase
  *
- * @return the next phase from this one, e.g. if called in TPL this returns
+ * Return: the next phase from this one, e.g. if called in TPL this returns
  *	PHASE_SPL
  */
 static inline enum u_boot_phase spl_next_phase(void)
@@ -159,7 +159,7 @@ static inline enum u_boot_phase spl_next_phase(void)
 /**
  * spl_phase_name() - Get the name of the current phase
  *
- * @return phase name
+ * Return: phase name
  */
 static inline const char *spl_phase_name(enum u_boot_phase phase)
 {
@@ -180,7 +180,7 @@ static inline const char *spl_phase_name(enum u_boot_phase phase)
  * spl_phase_prefix() - Get the prefix  of the current phase
  *
  * @phase: Phase to look up
- * @return phase prefix ("spl", "tpl", etc.)
+ * Return: phase prefix ("spl", "tpl", etc.)
  */
 static inline const char *spl_phase_prefix(enum u_boot_phase phase)
 {
@@ -291,7 +291,7 @@ ulong spl_get_image_size(void);
  * This returns the address that the next stage is linked to run at, i.e.
  * CONFIG_SPL_TEXT_BASE or CONFIG_SYS_TEXT_BASE
  *
- * @return text-base address
+ * Return: text-base address
  */
 ulong spl_get_image_text_base(void);
 
@@ -435,7 +435,7 @@ void spl_set_header_raw_uboot(struct spl_image_info *spl_image);
  *
  * @spl_image: Image description to set up
  * @header image header to parse
- * @return 0 if a header was correctly parsed, -ve on error
+ * Return: 0 if a header was correctly parsed, -ve on error
  */
 int spl_parse_image_header(struct spl_image_info *spl_image,
 			   const struct image_header *header);
@@ -484,7 +484,7 @@ void __noreturn jump_to_image_optee(struct spl_image_info *spl_image);
  * wants to load the kernel or U-Boot. This function should be provided by
  * the board.
  *
- * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
+ * Return: 0 if SPL should start the kernel, 1 if U-Boot must be started
  */
 int spl_start_uboot(void);
 
@@ -628,7 +628,7 @@ void spl_board_init(void);
  * This will normally be true, but if U-Boot jumps to second U-Boot, it will
  * be false. This should be implemented by board-specific code.
  *
- * @return true if U-Boot booted from SPL, else false
+ * Return: true if U-Boot booted from SPL, else false
  */
 bool spl_was_boot_source(void);
 
@@ -637,7 +637,7 @@ bool spl_was_boot_source(void);
  * @param usb_index - usb controller number
  * @param mmc_dev -  mmc device nubmer
  *
- * @return 0 on success, otherwise error code
+ * Return: 0 on success, otherwise error code
  */
 int spl_dfu_cmd(int usbctrl, char *dfu_alt_info, char *interface, char *devstr);
 
@@ -653,7 +653,7 @@ int spl_mmc_load_image(struct spl_image_info *spl_image,
  * @param raw_part	Partition to load from (in RAW mode)
  * @param raw_sect	Sector to load from (in RAW mode)
  *
- * @return 0 on success, otherwise error code
+ * Return: 0 on success, otherwise error code
  */
 int spl_mmc_load(struct spl_image_info *spl_image,
 		 struct spl_boot_device *bootdev,
@@ -669,7 +669,7 @@ int spl_mmc_load(struct spl_image_info *spl_image,
  * @param raw_part	Fat partition to load from
  * @param filename	Name of file to load
  *
- * @return 0 on success, otherwise error code
+ * Return: 0 on success, otherwise error code
  */
 int spl_usb_load(struct spl_image_info *spl_image,
 		 struct spl_boot_device *bootdev,