commit 47b4c025117482649ef7d5068e5070d4e2b5d65a
author Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Wed Jan 19 18:05:50 2022 +0100
committer Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Wed Jan 19 18:11:34 2022 +0100
tree 2fea02768d6005934547f075586c60ba7aca6253
parent 7ff76b46f110448032712b76b0272ac54805987e

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>

test/dm/acpi.h

diff --git a/test/dm/acpi.h b/test/dm/acpi.h
index 535db56..c6636b8 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 @@
  * 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);
 

test/dm/core.c

diff --git a/test/dm/core.c b/test/dm/core.c
index c76dfdb..0ce0b3c 100644
--- a/test/dm/core.c
+++ b/test/dm/core.c
@@ -579,7 +579,7 @@
  *		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[])

test/dm/of_platdata.c

diff --git a/test/dm/of_platdata.c b/test/dm/of_platdata.c
index ec41087..7af798b 100644
--- a/test/dm/of_platdata.c
+++ b/test/dm/of_platdata.c
@@ -103,7 +103,7 @@
  * @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[])

test/dm/test-dm.c

diff --git a/test/dm/test-dm.c b/test/dm/test-dm.c
index 9ba2ba2..f5cda81 100644
--- a/test/dm/test-dm.c
+++ b/test/dm/test-dm.c
@@ -27,7 +27,7 @@
  *
  * @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)
 {

test/dm/video.c

diff --git a/test/dm/video.c b/test/dm/video.c
index d4a3c9c..17a33cc 100644
--- a/test/dm/video.c
+++ b/test/dm/video.c
@@ -59,7 +59,7 @@
  *
  * @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 @@
  *
  * @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 @@
  *		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)