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>

include/dm/acpi.h

diff --git a/include/dm/acpi.h b/include/dm/acpi.h
index 7f1f2ef..0fa239e 100644
--- a/include/dm/acpi.h
+++ b/include/dm/acpi.h
@@ -139,7 +139,7 @@
  * @dev: Device to check
  * @out_name: Place to put the name, must hold at least ACPI_NAME_MAX
  *	bytes
- * @return 0 if OK, -ENOENT if no name is available, other -ve value on
+ * Return: 0 if OK, -ENOENT if no name is available, other -ve value on
  *	other error
  */
 int acpi_get_name(const struct udevice *dev, char *out_name);
@@ -159,7 +159,7 @@
  *
  * @out_name: Place to put the name
  * @name: Name to copy
- * @return 0 (always)
+ * Return: 0 (always)
  */
 int acpi_copy_name(char *out_name, const char *name);
 
@@ -169,7 +169,7 @@
  * This scans through all devices and tells them to write any tables they want
  * to write.
  *
- * @return 0 if OK, -ve if any device returned an error
+ * Return: 0 if OK, -ve if any device returned an error
  */
 int acpi_write_dev_tables(struct acpi_ctx *ctx);
 
@@ -179,7 +179,7 @@
  * This is called to create the SSDT code for all devices.
  *
  * @ctx: ACPI context to use
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int acpi_fill_ssdt(struct acpi_ctx *ctx);
 
@@ -189,7 +189,7 @@
  * This is called to create the DSDT code for all devices.
  *
  * @ctx: ACPI context to use
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int acpi_inject_dsdt(struct acpi_ctx *ctx);
 
@@ -200,7 +200,7 @@
  *
  * @ctx: ACPI context to use
  * @nhlt: Pointer to nhlt information to add to
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int acpi_setup_nhlt(struct acpi_ctx *ctx, struct nhlt *nhlt);
 
@@ -223,7 +223,7 @@
  * @dev: Device to check
  * @out_path: Buffer to place the path in (should be ACPI_PATH_MAX long)
  * @maxlen: Size of buffer (typically ACPI_PATH_MAX)
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int acpi_get_path(const struct udevice *dev, char *out_path, int maxlen);