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>

2 files changed, 11 insertions, 11 deletions

diff --git a/include/test/suites.h b/include/test/suites.h
index d35cd83a4eb..6553a765c6a 100644
--- a/include/test/suites.h
+++ b/include/test/suites.h
@@ -20,7 +20,7 @@ struct unit_test;
  * @argc:	Argument count provided. Must be >= 1. If this is 1 then all
  *		tests are run, otherwise only the one named @argv[1] is run.
  * @argv:	Arguments: argv[1] is the test to run (if @argc >= 2)
- * @return 0 if OK, CMD_RET_FAILURE on failure
+ * Return: 0 if OK, CMD_RET_FAILURE on failure
  */
 int cmd_ut_category(const char *name, const char *prefix,
 		    struct unit_test *tests, int n_ents,
diff --git a/include/test/ut.h b/include/test/ut.h
index fb2e5fcff2c..18740f5807c 100644
--- a/include/test/ut.h
+++ b/include/test/ut.h
@@ -52,7 +52,7 @@ void ut_failf(struct unit_test_state *uts, const char *fname, int line,
  *
  * @uts: Test state
  * @fmt: printf() format string for the error, followed by args
- * @return 0 if OK, other value on error
+ * Return: 0 if OK, other value on error
  */
 int ut_check_console_line(struct unit_test_state *uts, const char *fmt, ...)
 			__attribute__ ((format (__printf__, 2, 3)));
@@ -69,7 +69,7 @@ int ut_check_console_line(struct unit_test_state *uts, const char *fmt, ...)
  *
  * @uts: Test state
  * @fmt: printf() format string for the error, followed by args
- * @return 0 if OK, other value on error
+ * Return: 0 if OK, other value on error
  */
 int ut_check_console_linen(struct unit_test_state *uts, const char *fmt, ...)
 			__attribute__ ((format (__printf__, 2, 3)));
@@ -78,7 +78,7 @@ int ut_check_console_linen(struct unit_test_state *uts, const char *fmt, ...)
  * ut_check_skipline() - Check that the next console line exists and skip it
  *
  * @uts: Test state
- * @return 0 if OK, other value on error
+ * Return: 0 if OK, other value on error
  */
 int ut_check_skipline(struct unit_test_state *uts);
 
@@ -93,7 +93,7 @@ int ut_check_skipline(struct unit_test_state *uts);
  *
  * @uts: Test state
  * @fmt: printf() format string to look for, followed by args
- * @return 0 if OK, -ENOENT if not found, other value on error
+ * Return: 0 if OK, -ENOENT if not found, other value on error
  */
 int ut_check_skip_to_line(struct unit_test_state *uts, const char *fmt, ...);
 
@@ -104,7 +104,7 @@ int ut_check_skip_to_line(struct unit_test_state *uts, const char *fmt, ...);
  * from the console
  *
  * @uts: Test state
- * @return 0 if OK (console has no output), other value on error
+ * Return: 0 if OK (console has no output), other value on error
  */
 int ut_check_console_end(struct unit_test_state *uts);
 
@@ -114,7 +114,7 @@ int ut_check_console_end(struct unit_test_state *uts);
  * This only supports a byte dump.
  *
  * @total_bytes: Size of the expected dump in bytes`
- * @return 0 if OK (looks like a dump and the length matches), other value on
+ * Return: 0 if OK (looks like a dump and the length matches), other value on
  *	error
  */
 int ut_check_console_dump(struct unit_test_state *uts, int total_bytes);
@@ -332,7 +332,7 @@ int ut_check_console_dump(struct unit_test_state *uts, int total_bytes);
 /**
  * ut_check_free() - Return the number of bytes free in the malloc() pool
  *
- * @return bytes free
+ * Return: bytes free
  */
 ulong ut_check_free(void);
 
@@ -340,7 +340,7 @@ ulong ut_check_free(void);
  * ut_check_delta() - Return the number of bytes allocated/freed
  *
  * @last: Last value from ut_check_free
- * @return free memory delta from @last; positive means more memory has been
+ * Return: free memory delta from @last; positive means more memory has been
  *	allocated, negative means less has been allocated (i.e. some is freed)
  */
 long ut_check_delta(ulong last);
@@ -377,7 +377,7 @@ void ut_set_skip_delays(struct unit_test_state *uts, bool skip_delays);
 /**
  * test_get_state() - Get the active test state
  *
- * @return the currently active test state, or NULL if none
+ * Return: the currently active test state, or NULL if none
  */
 struct unit_test_state *test_get_state(void);
 
@@ -403,7 +403,7 @@ void test_set_state(struct unit_test_state *uts);
  * @count: Number of tests to run
  * @select_name: Name of a single test to run (from the list provided). If NULL
  *	then all tests are run
- * @return 0 if all tests passed, -1 if any failed
+ * Return: 0 if all tests passed, -1 if any failed
  */
 int ut_run_list(const char *name, const char *prefix, struct unit_test *tests,
 		int count, const char *select_name);