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

diff --git a/include/bootstage.h b/include/bootstage.h
index 8d1989ac0e5..99a334ad54b 100644
--- a/include/bootstage.h
+++ b/include/bootstage.h
@@ -248,7 +248,7 @@ void show_boot_progress(int val);
  * Call this after relocation has happened and after malloc has been initted.
  * We need to copy any pointers in bootstage records that were added pre-
  * relocation, since memory can be overwritten later.
- * @return Always returns 0, to indicate success
+ * Return: Always returns 0, to indicate success
  */
 int bootstage_relocate(void);
 
@@ -280,7 +280,7 @@ ulong bootstage_mark_name(enum bootstage_id id, const char *name);
  * @param file		Filename to record (NULL if none)
  * @param func		Function name to record
  * @param linenum	Line number to record
- * @return recorded time stamp
+ * Return: recorded time stamp
  */
 ulong bootstage_mark_code(const char *file, const char *func,
 			  int linenum);
@@ -294,7 +294,7 @@ ulong bootstage_mark_code(const char *file, const char *func,
  *
  * @param id	Bootstage id to record this timestamp against
  * @param name	Textual name to display for this id in the report (maybe NULL)
- * @return start timestamp in microseconds
+ * Return: start timestamp in microseconds
  */
 uint32_t bootstage_start(enum bootstage_id id, const char *name);
 
@@ -306,7 +306,7 @@ uint32_t bootstage_start(enum bootstage_id id, const char *name);
  * as many times as you like.
  *
  * @param id	Bootstage id to record this timestamp against
- * @return time spent in this iteration of the activity (i.e. the time now
+ * Return: time spent in this iteration of the activity (i.e. the time now
  *		less the start time recorded in the last bootstage_start() call
  *		with this id.
  */
@@ -318,7 +318,7 @@ void bootstage_report(void);
 /**
  * Add bootstage information to the device tree
  *
- * @return 0 if ok, -ve on error
+ * Return: 0 if ok, -ve on error
  */
 int bootstage_fdt_add_report(void);
 
@@ -327,7 +327,7 @@ int bootstage_fdt_add_report(void);
  *
  * @param base	Base address of memory buffer
  * @param size	Size of memory buffer
- * @return 0 if stashed ok, -1 if out of space
+ * Return: 0 if stashed ok, -1 if out of space
  */
 int bootstage_stash(void *base, int size);
 
@@ -339,7 +339,7 @@ int bootstage_stash(void *base, int size);
  *
  * @param base	Base address of memory buffer
  * @param size	Size of memory buffer (-1 if unknown)
- * @return 0 if unstashed ok, -ENOENT if bootstage info not found, -ENOSPC if
+ * Return: 0 if unstashed ok, -ENOENT if bootstage info not found, -ENOSPC if
  *	there is not space for read the stashed data, or other error if
  *	something else went wrong
  */
@@ -348,7 +348,7 @@ int bootstage_unstash(const void *base, int size);
 /**
  * bootstage_get_size() - Get the size of the bootstage data
  *
- * @return size of boostage data in bytes
+ * Return: size of boostage data in bytes
  */
 int bootstage_get_size(void);