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>

8 files changed, 20 insertions, 20 deletions

diff --git a/test/compression.c b/test/compression.c
index 26d3c80fb5..82e29c9b86 100644
--- a/test/compression.c
+++ b/test/compression.c
@@ -457,7 +457,7 @@ static int compress_using_none(struct unit_test_state *uts,
  *
  * @comp_type:	Compression type to test
  * @compress:	Our function to compress data
- * @return 0 if OK, non-zero on failure
+ * Return: 0 if OK, non-zero on failure
  */
 static int run_bootm_test(struct unit_test_state *uts, int comp_type,
 			  mutate_func compress)
diff --git a/test/dm/acpi.h b/test/dm/acpi.h
index 535db56b51..c6636b8824 100644
--- a/test/dm/acpi.h
+++ b/test/dm/acpi.h
@@ -17,7 +17,7 @@
  *
  * @ctxp: Returns allocated context
  * @size: Size to allocate in bytes
- * @return 0 if OK, -ENOMEM if out of memory
+ * Return: 0 if OK, -ENOMEM if out of memory
  */
 int acpi_test_alloc_context_size(struct acpi_ctx **ctxp, int size);
 
@@ -25,7 +25,7 @@ int acpi_test_alloc_context_size(struct acpi_ctx **ctxp, int size);
  * acpi_test_get_length() - decode a three-byte length field
  *
  * @ptr: Length encoded as per ACPI
- * @return decoded length, or -EINVAL on error
+ * Return: decoded length, or -EINVAL on error
  */
 int acpi_test_get_length(u8 *ptr);
 
diff --git a/test/dm/core.c b/test/dm/core.c
index c76dfdb165..0ce0b3c4a2 100644
--- a/test/dm/core.c
+++ b/test/dm/core.c
@@ -579,7 +579,7 @@ DM_TEST(dm_test_uclass, 0);
  *		receive an incrementing value
  * @child:	If not NULL, then the child device pointers are written into
  *		this array.
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 static int create_children(struct unit_test_state *uts, struct udevice *parent,
 			   int count, int key, struct udevice *child[])
diff --git a/test/dm/of_platdata.c b/test/dm/of_platdata.c
index ec41087a55..7af798b8d3 100644
--- a/test/dm/of_platdata.c
+++ b/test/dm/of_platdata.c
@@ -103,7 +103,7 @@ DM_TEST(dm_test_of_plat_props, UT_TESTF_SCAN_PDATA);
  * @uts: Test state
  * @parent: Parent to search
  * @found: bool array to update
- * @return 0 if OK, non-zero on error
+ * Return: 0 if OK, non-zero on error
  */
 static int find_driver_info(struct unit_test_state *uts, struct udevice *parent,
 			    bool found[])
diff --git a/test/dm/test-dm.c b/test/dm/test-dm.c
index 9ba2ba23d5..f5cda81bbf 100644
--- a/test/dm/test-dm.c
+++ b/test/dm/test-dm.c
@@ -27,7 +27,7 @@ DECLARE_GLOBAL_DATA_PTR;
  *
  * @test_name: Name of single test to run (e.g. "dm_test_fdt_pre_reloc" or just
  *	"fdt_pre_reloc"), or NULL to run all
- * @return 0 if all tests passed, 1 if not
+ * Return: 0 if all tests passed, 1 if not
  */
 static int dm_test_run(const char *test_name)
 {
diff --git a/test/dm/video.c b/test/dm/video.c
index d4a3c9c6c1..17a33cc7af 100644
--- a/test/dm/video.c
+++ b/test/dm/video.c
@@ -59,7 +59,7 @@ DM_TEST(dm_test_video_base, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
  *
  * @uts:	Test state
  * @dev:	Video device
- * @return compressed size of the frame buffer, or -ve on error
+ * Return: compressed size of the frame buffer, or -ve on error
  */
 static int compress_frame_buffer(struct unit_test_state *uts,
 				 struct udevice *dev)
@@ -120,7 +120,7 @@ static int select_vidconsole(struct unit_test_state *uts, const char *drv_name)
  *
  * @uts: Test state
  * @devp: Returns video device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 static int video_get_nologo(struct unit_test_state *uts, struct udevice **devp)
 {
@@ -233,7 +233,7 @@ DM_TEST(dm_test_video_ansi, UT_TESTF_SCAN_PDATA | UT_TESTF_SCAN_FDT);
  *		2=upside down, 3=90 degree counterclockwise)
  * @wrap_size:	Expected size of compressed frame buffer for the wrap test
  * @scroll_size: Same for the scroll test
- * @return 0 on success
+ * Return: 0 on success
  */
 static int check_vidconsole_output(struct unit_test_state *uts, int rot,
 				   int wrap_size, int scroll_size)
diff --git a/test/log/syslog_test.h b/test/log/syslog_test.h
index bfaa6daef8..39cce4ed49 100644
--- a/test/log/syslog_test.h
+++ b/test/log/syslog_test.h
@@ -49,7 +49,7 @@ int sb_log_tx_handler(struct udevice *dev, void *packet, unsigned int len);
  * syslog_test_setup() - Enable syslog logging ready for tests
  *
  * @uts: Test state
- * @return 0 if OK, -ENOENT if the syslog log driver is not found
+ * Return: 0 if OK, -ENOENT if the syslog log driver is not found
  */
 int syslog_test_setup(struct unit_test_state *uts);
 
@@ -57,7 +57,7 @@ int syslog_test_setup(struct unit_test_state *uts);
  * syslog_test_finish() - Disable syslog logging after tests
  *
  * @uts: Test state
- * @return 0 if OK, -ENOENT if the syslog log driver is not found
+ * Return: 0 if OK, -ENOENT if the syslog log driver is not found
  */
 int syslog_test_finish(struct unit_test_state *uts);
 
diff --git a/test/test-main.c b/test/test-main.c
index 3cdf6849c5..8fcb02ecea 100644
--- a/test/test-main.c
+++ b/test/test-main.c
@@ -106,7 +106,7 @@ static int do_autoprobe(struct unit_test_state *uts)
  * This skips long/slow tests where there is not much value in running a flat
  * DT test in addition to a live DT test.
  *
- * @return true to run the given test on the flat device tree
+ * Return: true to run the given test on the flat device tree
  */
 static bool ut_test_run_on_flattree(struct unit_test *test)
 {
@@ -130,7 +130,7 @@ static bool ut_test_run_on_flattree(struct unit_test *test)
  *	a prefix.
  * @test_name: Name of current test
  * @select_name: Name of test to run (or NULL for all)
- * @return true to run this test, false to skip it
+ * Return: true to run this test, false to skip it
  */
 static bool test_matches(const char *prefix, const char *test_name,
 			 const char *select_name)
@@ -171,7 +171,7 @@ static bool test_matches(const char *prefix, const char *test_name,
  *
  * @tests: List of tests to run
  * @count: Number of tests to ru
- * @return true if any of the tests have the UT_TESTF_DM flag
+ * Return: true if any of the tests have the UT_TESTF_DM flag
  */
 static bool ut_list_has_dm_tests(struct unit_test *tests, int count)
 {
@@ -189,7 +189,7 @@ static bool ut_list_has_dm_tests(struct unit_test *tests, int count)
  * dm_test_restore() Put things back to normal so sandbox works as expected
  *
  * @of_root: Value to set for of_root
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 static int dm_test_restore(struct device_node *of_root)
 {
@@ -212,7 +212,7 @@ static int dm_test_restore(struct device_node *of_root)
  *
  * @uts: Test state
  * @test: Test to prepare for
- * @return 0 if OK, -EAGAIN to skip this test since some required feature is not
+ * Return: 0 if OK, -EAGAIN to skip this test since some required feature is not
  *	available, other -ve on error (meaning that testing cannot likely
  *	continue)
  */
@@ -253,7 +253,7 @@ static int test_pre_run(struct unit_test_state *uts, struct unit_test *test)
  *
  * @uts: Test state
  * @test: Test to clean up after
- * @return 0 if OK, -ve on error (meaning that testing cannot likely continue)
+ * Return: 0 if OK, -ve on error (meaning that testing cannot likely continue)
  */
 static int test_post_run(struct unit_test_state *uts, struct unit_test *test)
 {
@@ -275,7 +275,7 @@ static int test_post_run(struct unit_test_state *uts, struct unit_test *test)
  *	incremented by the number of failures (0, one hopes)
  * @test_name: Test to run
  * @name: Name of test, possibly skipping a prefix that should not be displayed
- * @return 0 if all tests passed, -EAGAIN if the test should be skipped, -1 if
+ * Return: 0 if all tests passed, -EAGAIN if the test should be skipped, -1 if
  *	any failed
  */
 static int ut_run_test(struct unit_test_state *uts, struct unit_test *test,
@@ -323,7 +323,7 @@ static int ut_run_test(struct unit_test_state *uts, struct unit_test *test,
  *	incremented by the number of failures (0, one hopes)
  * @test: Test to run
  * @name: Name of test, possibly skipping a prefix that should not be displayed
- * @return 0 if all tests passed, -EAGAIN if the test should be skipped, -1 if
+ * Return: 0 if all tests passed, -EAGAIN if the test should be skipped, -1 if
  *	any failed
  */
 static int ut_run_test_live_flat(struct unit_test_state *uts,
@@ -371,7 +371,7 @@ static int ut_run_test_live_flat(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, -ENOENT if test @select_name was not found,
+ * Return: 0 if all tests passed, -ENOENT if test @select_name was not found,
  *	-EBADF if any failed
  */
 static int ut_run_tests(struct unit_test_state *uts, const char *prefix,