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>

12 files changed, 21 insertions, 21 deletions

diff --git a/common/autoboot.c b/common/autoboot.c
index 6251c683108..b8861d56218 100644
--- a/common/autoboot.c
+++ b/common/autoboot.c
@@ -69,7 +69,7 @@ static int menukey;
  * before starting to enter the password.
  *
  * @etime: Timeout value ticks (stop when get_ticks() reachs this)
- * @return 0 if autoboot should continue, 1 if it should stop
+ * Return: 0 if autoboot should continue, 1 if it should stop
  */
 static int passwd_abort_crypt(uint64_t etime)
 {
@@ -143,7 +143,7 @@ static int slow_equals(u8 *a, u8 *b, int len)
  * This checks for the user entering a SHA256 hash within a given time.
  *
  * @etime: Timeout value ticks (stop when get_ticks() reachs this)
- * @return 0 if autoboot should continue, 1 if it should stop
+ * Return: 0 if autoboot should continue, 1 if it should stop
  */
 static int passwd_abort_sha256(uint64_t etime)
 {
@@ -219,7 +219,7 @@ static int passwd_abort_sha256(uint64_t etime)
  * This checks for the user entering a string within a given time.
  *
  * @etime: Timeout value ticks (stop when get_ticks() reachs this)
- * @return 0 if autoboot should continue, 1 if it should stop
+ * Return: 0 if autoboot should continue, 1 if it should stop
  */
 static int passwd_abort_key(uint64_t etime)
 {
@@ -315,7 +315,7 @@ static void flush_stdin(void)
  * sha256-fallback has been enabled via the config setting
  * `AUTOBOOT_SHA256_FALLBACK`.
  *
- * @return `false` if we must not fall-back, `true` if plain sha256 should be tried
+ * Return: `false` if we must not fall-back, `true` if plain sha256 should be tried
  */
 static bool fallback_to_sha256(void)
 {
diff --git a/common/board_r.c b/common/board_r.c
index 60eced6f7f9..c24d9b4e220 100644
--- a/common/board_r.c
+++ b/common/board_r.c
@@ -418,7 +418,7 @@ static int initr_pvblock(void)
  * NOTE: Loading the environment early can be a bad idea if security is
  *       important, since no verification is done on the environment.
  *
- * @return 0 if environment should not be loaded, !=0 if it is ok to load
+ * Return: 0 if environment should not be loaded, !=0 if it is ok to load
  */
 static int should_load_env(void)
 {
diff --git a/common/bootstage.c b/common/bootstage.c
index 46211056821..0fd33be97ea 100644
--- a/common/bootstage.c
+++ b/common/bootstage.c
@@ -230,7 +230,7 @@ uint32_t bootstage_accum(enum bootstage_id id)
  * @param buf	Buffer to put name if needed
  * @param len	Length of buffer
  * @param rec	Boot stage record to get the name from
- * @return pointer to name, either from the record or pointing to buf.
+ * Return: pointer to name, either from the record or pointing to buf.
  */
 static const char *get_record_name(char *buf, int len,
 				   const struct bootstage_record *rec)
@@ -273,7 +273,7 @@ static int h_compare_record(const void *r1, const void *r2)
  * Add all bootstage timings to a device tree.
  *
  * @param blob	Device tree blob
- * @return 0 on success, != 0 on failure.
+ * Return: 0 on success, != 0 on failure.
  */
 static int add_bootstages_devicetree(struct fdt_header *blob)
 {
diff --git a/common/cli.c b/common/cli.c
index d86046a728b..a7e3d84b68f 100644
--- a/common/cli.c
+++ b/common/cli.c
@@ -27,7 +27,7 @@
  *
  * @param cmd	Command to run
  * @param flag	Execution flags (CMD_FLAG_...)
- * @return 0 on success, or != 0 on error.
+ * Return: 0 on success, or != 0 on error.
  */
 int run_command(const char *cmd, int flag)
 {
@@ -54,7 +54,7 @@ int run_command(const char *cmd, int flag)
  *
  * @param cmd	Command to run
  * @param flag	Execution flags (CMD_FLAG_...)
- * @return 0 (not repeatable) or 1 (repeatable) on success, -1 on error.
+ * Return: 0 (not repeatable) or 1 (repeatable) on success, -1 on error.
  */
 int run_command_repeatable(const char *cmd, int flag)
 {
diff --git a/common/command.c b/common/command.c
index 95af73f17b5..41c91c6d8c8 100644
--- a/common/command.c
+++ b/common/command.c
@@ -570,7 +570,7 @@ int cmd_discard_repeatable(struct cmd_tbl *cmdtp, int flag, int argc,
  * @param argc		Number of arguments (arg 0 must be the command text)
  * @param argv		Arguments
  * @param repeatable	Can the command be repeated
- * @return 0 if command succeeded, else non-zero (CMD_RET_...)
+ * Return: 0 if command succeeded, else non-zero (CMD_RET_...)
  */
 static int cmd_call(struct cmd_tbl *cmdtp, int flag, int argc,
 		    char *const argv[], int *repeatable)
diff --git a/common/console.c b/common/console.c
index 2bccc8ab103..92b1c93be1a 100644
--- a/common/console.c
+++ b/common/console.c
@@ -213,7 +213,7 @@ static int console_setfile(int file, struct stdio_dev * dev)
  * console_dev_is_serial() - Check if a stdio device is a serial device
  *
  * @sdev: Device to check
- * @return true if this device is in the serial uclass (or for pre-driver-model,
+ * Return: true if this device is in the serial uclass (or for pre-driver-model,
  * whether it is called "serial".
  */
 static bool console_dev_is_serial(struct stdio_dev *sdev)
diff --git a/common/edid.c b/common/edid.c
index fa85bcd6a15..556c4e3434b 100644
--- a/common/edid.c
+++ b/common/edid.c
@@ -139,7 +139,7 @@ static void decode_timing(u8 *buf, struct display_timing *timing)
 /**
  * Check if HDMI vendor specific data block is present in CEA block
  * @param info	CEA extension block
- * @return true if block is found
+ * Return: true if block is found
  */
 static bool cea_is_hdmi_vsdb_present(struct edid_cea861_info *info)
 {
@@ -274,7 +274,7 @@ int edid_get_timing(u8 *buf, int buf_size, struct display_timing *timing,
  * Snip the tailing whitespace/return of a string.
  *
  * @param string	The string to be snipped
- * @return the snipped string
+ * Return: the snipped string
  */
 static char *snip(char *string)
 {
diff --git a/common/fdt_support.c b/common/fdt_support.c
index c6b93e78890..efbd900e1f4 100644
--- a/common/fdt_support.c
+++ b/common/fdt_support.c
@@ -2049,7 +2049,7 @@ int fdt_overlay_apply_verbose(void *fdt, void *fdto)
  * fdt_valid() - Check if an FDT is valid. If not, change it to NULL
  *
  * @blobp: Pointer to FDT pointer
- * @return 1 if OK, 0 if bad (in which case *blobp is set to NULL)
+ * Return: 1 if OK, 0 if bad (in which case *blobp is set to NULL)
  */
 int fdt_valid(struct fdt_header **blobp)
 {
diff --git a/common/hash.c b/common/hash.c
index 79202e18a2a..9e53545dbde 100644
--- a/common/hash.c
+++ b/common/hash.c
@@ -500,7 +500,7 @@ static void store_result(struct hash_algo *algo, const uint8_t *sum,
  * @allow_env_vars:	non-zero to permit storing the result to an environment
  *			variable. If 0 then verify_str is assumed to be an
  *			address, and the * prefix is not expected.
- * @return 0 if ok, non-zero on error
+ * Return: 0 if ok, non-zero on error
  */
 static int parse_verify_sum(struct hash_algo *algo, char *verify_str,
 			    uint8_t *vsum, int allow_env_vars)
diff --git a/common/log.c b/common/log.c
index 1aaa6c1527b..f7e0c0fbf55 100644
--- a/common/log.c
+++ b/common/log.c
@@ -147,7 +147,7 @@ bool log_has_file(const char *file_list, const char *file)
  *
  * @ldev: Log device to check
  * @rec: Log record to check
- * @return true if @rec is not blocked by the filters in @ldev, false if it is
+ * Return: true if @rec is not blocked by the filters in @ldev, false if it is
  */
 static bool log_passes_filters(struct log_device *ldev, struct log_rec *rec)
 {
@@ -390,7 +390,7 @@ int log_remove_filter(const char *drv_name, int filter_num)
  * log_find_device_by_drv() - Find a device by its driver
  *
  * @drv: Log driver
- * @return Device associated with that driver, or NULL if not found
+ * Return: Device associated with that driver, or NULL if not found
  */
 static struct log_device *log_find_device_by_drv(struct log_driver *drv)
 {
diff --git a/common/spl/spl.c b/common/spl/spl.c
index c5360f30ae3..4bb9455efbd 100644
--- a/common/spl/spl.c
+++ b/common/spl/spl.c
@@ -446,7 +446,7 @@ static inline int write_spl_handoff(void) { return 0; }
  * get_bootstage_id() - Get the bootstage ID to emit
  *
  * @start: true if this is for starting SPL, false for ending it
- * @return bootstage ID to use
+ * Return: bootstage ID to use
  */
 static enum bootstage_id get_bootstage_id(bool start)
 {
@@ -617,7 +617,7 @@ static int spl_load_image(struct spl_image_info *spl_image,
  * @spl_image: Place to put the image details if successful
  * @spl_boot_list: List of boot devices to try
  * @count: Number of elements in spl_boot_list
- * @return 0 if OK, -ENODEV if there were no boot devices
+ * Return: 0 if OK, -ENODEV if there were no boot devices
  *	if CONFIG_SHOW_ERRORS is enabled, returns -ENXIO if there were
  *	devices but none worked
  */
@@ -883,7 +883,7 @@ __weak void spl_relocate_stack_check(void)
  * All of this is done using the same layout and alignments as done in
  * board_init_f_init_reserve() / board_init_f_alloc_reserve().
  *
- * @return new stack location, or 0 to use the same stack
+ * Return: new stack location, or 0 to use the same stack
  */
 ulong spl_relocate_stack_gd(void)
 {
diff --git a/common/stdio.c b/common/stdio.c
index 0f2eb6f0d61..976f51c2527 100644
--- a/common/stdio.c
+++ b/common/stdio.c
@@ -144,7 +144,7 @@ struct list_head* stdio_get_list(void)
  * @name:	stdio device name (e.g. "vidconsole")
  * id:		Uclass ID of device to look for (e.g. UCLASS_VIDEO)
  * @sdevp:	Returns stdout device, if found, else NULL
- * @return 0 if found, -ENOENT if no device found with that name, other -ve
+ * Return: 0 if found, -ENOENT if no device found with that name, other -ve
  *	   on other error
  */
 static int stdio_probe_device(const char *name, enum uclass_id id,