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>

5 files changed, 30 insertions, 30 deletions

diff --git a/include/acpi/acpi_device.h b/include/acpi/acpi_device.h
index 2c8846250b6..16bcf3c6f8d 100644
--- a/include/acpi/acpi_device.h
+++ b/include/acpi/acpi_device.h
@@ -322,7 +322,7 @@ struct acpi_i2c_priv {
  * @dev: Device to check
  * @buf: 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_device_path(const struct udevice *dev, char *buf, int maxlen);
 
@@ -335,7 +335,7 @@ int acpi_device_path(const struct udevice *dev, char *buf, int maxlen);
  * @dev: Device to check
  * @buf: Buffer to place the path in (should be ACPI_PATH_MAX long)
  * @maxlen: Size of buffer (typically ACPI_PATH_MAX)
- * @return 0 if OK, -EINVAL if the device has no parent, other -ve on other
+ * Return: 0 if OK, -EINVAL if the device has no parent, other -ve on other
  *	error
  */
 int acpi_device_scope(const struct udevice *dev, char *scope, int maxlen);
@@ -347,7 +347,7 @@ int acpi_device_scope(const struct udevice *dev, char *scope, int maxlen);
  * inactive or hidden devices.
  *
  * @dev: Device to check
- * @return device status, as ACPI_DSTATUS_...
+ * Return: device status, as ACPI_DSTATUS_...
  */
 enum acpi_dev_status acpi_device_status(const struct udevice *dev);
 
@@ -359,7 +359,7 @@ enum acpi_dev_status acpi_device_status(const struct udevice *dev);
  *
  * @ctx: ACPI context pointer
  * @req_irq: Interrupt to output
- * @return IRQ pin number if OK, -ve on error
+ * Return: IRQ pin number if OK, -ve on error
  */
 int acpi_device_write_interrupt_irq(struct acpi_ctx *ctx,
 				    const struct irq *req_irq);
@@ -368,7 +368,7 @@ int acpi_device_write_interrupt_irq(struct acpi_ctx *ctx,
  * acpi_device_write_gpio() - Write GpioIo() or GpioInt() descriptor
  *
  * @gpio: GPIO information to write
- * @return GPIO pin number of first GPIO if OK, -ve on error
+ * Return: GPIO pin number of first GPIO if OK, -ve on error
  */
 int acpi_device_write_gpio(struct acpi_ctx *ctx, const struct acpi_gpio *gpio);
 
@@ -380,7 +380,7 @@ int acpi_device_write_gpio(struct acpi_ctx *ctx, const struct acpi_gpio *gpio);
  *
  * @ctx: ACPI context pointer
  * @desc: GPIO to write
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int acpi_device_write_gpio_desc(struct acpi_ctx *ctx,
 				const struct gpio_desc *desc);
@@ -394,7 +394,7 @@ int acpi_device_write_gpio_desc(struct acpi_ctx *ctx,
  * If an interrupt is found, an ACPI interrupt descriptor is written to the ACPI
  * output. If not, but if a GPIO is found, a GPIO descriptor is written.
  *
- * @return irq or GPIO pin number if OK, -ve if neither an interrupt nor a GPIO
+ * Return: irq or GPIO pin number if OK, -ve if neither an interrupt nor a GPIO
  *	could be found, or some other error occurred
  */
 int acpi_device_write_interrupt_or_gpio(struct acpi_ctx *ctx,
@@ -419,7 +419,7 @@ int acpi_device_write_dsm_i2c_hid(struct acpi_ctx *ctx,
  *
  * @ctx: ACPI context pointer
  * @dev: I2C device to write
- * @return I2C address of device if OK, -ve on error
+ * Return: I2C address of device if OK, -ve on error
  */
 int acpi_device_write_i2c_dev(struct acpi_ctx *ctx, const struct udevice *dev);
 
@@ -431,7 +431,7 @@ int acpi_device_write_i2c_dev(struct acpi_ctx *ctx, const struct udevice *dev);
  *
  * @ctx: ACPI context pointer
  * @dev: SPI device to write
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int acpi_device_write_spi_dev(struct acpi_ctx *ctx, const struct udevice *dev);
 
@@ -466,7 +466,7 @@ int acpi_device_write_spi_dev(struct acpi_ctx *ctx, const struct udevice *dev);
  * @stop_off_delay_ms: Delay to be inserted after enabling stop.
  *	(_OFF method delay)
  *
- * @return 0 if OK, -ve if at least one GPIO is not provided
+ * Return: 0 if OK, -ve if at least one GPIO is not provided
  */
 int acpi_device_add_power_res(struct acpi_ctx *ctx, u32 tx_state_val,
 			      const char *dw0_read, const char *dw0_write,
@@ -490,7 +490,7 @@ int acpi_device_add_power_res(struct acpi_ctx *ctx, u32 tx_state_val,
  *
  * @dev: Device to check
  * @out_name: Place to put the name (must hold ACPI_NAME_MAX bytes)
- * @return 0 if a name was found, -ENOENT if not found, -ENXIO if the device
+ * Return: 0 if a name was found, -ENOENT if not found, -ENXIO if the device
  *	sequence number could not be determined
  */
 int acpi_device_infer_name(const struct udevice *dev, char *out_name);
diff --git a/include/acpi/acpi_dp.h b/include/acpi/acpi_dp.h
index 5e539b1d218..be02cc34959 100644
--- a/include/acpi/acpi_dp.h
+++ b/include/acpi/acpi_dp.h
@@ -124,7 +124,7 @@ struct acpi_dp {
  * acpi_dp_new_table() - Start a new Device Property table
  *
  * @ref: ACPI reference (e.g. "_DSD")
- * @return pointer to table, or NULL if out of memory
+ * Return: pointer to table, or NULL if out of memory
  */
 struct acpi_dp *acpi_dp_new_table(const char *ref);
 
@@ -136,7 +136,7 @@ struct acpi_dp *acpi_dp_new_table(const char *ref);
  * @dp: Table to add this property to
  * @name: Name of property, or NULL for none
  * @value: Integer value
- * @return pointer to new node, or NULL if out of memory
+ * Return: pointer to new node, or NULL if out of memory
  */
 struct acpi_dp *acpi_dp_add_integer(struct acpi_dp *dp, const char *name,
 				    u64 value);
@@ -149,7 +149,7 @@ struct acpi_dp *acpi_dp_add_integer(struct acpi_dp *dp, const char *name,
  * @dp: Table to add this property to
  * @name: Name of property, or NULL for none
  * @string: String value
- * @return pointer to new node, or NULL if out of memory
+ * Return: pointer to new node, or NULL if out of memory
  */
 struct acpi_dp *acpi_dp_add_string(struct acpi_dp *dp, const char *name,
 				   const char *string);
@@ -162,7 +162,7 @@ struct acpi_dp *acpi_dp_add_string(struct acpi_dp *dp, const char *name,
  * @dp: Table to add this property to
  * @name: Name of property, or NULL for none
  * @reference: Reference value
- * @return pointer to new node, or NULL if out of memory
+ * Return: pointer to new node, or NULL if out of memory
  */
 struct acpi_dp *acpi_dp_add_reference(struct acpi_dp *dp, const char *name,
 				      const char *reference);
@@ -175,7 +175,7 @@ struct acpi_dp *acpi_dp_add_reference(struct acpi_dp *dp, const char *name,
  *
  * @dp: Table to add this property to
  * @name: Name of property, or NULL for none
- * @return pointer to new node, or NULL if out of memory
+ * Return: pointer to new node, or NULL if out of memory
  */
 struct acpi_dp *acpi_dp_add_array(struct acpi_dp *dp, struct acpi_dp *array);
 
@@ -187,7 +187,7 @@ struct acpi_dp *acpi_dp_add_array(struct acpi_dp *dp, struct acpi_dp *array);
  *
  * @dp: Table to add this property to
  * @name: Name of property, or NULL for none
- * @return pointer to new array node, or NULL if out of memory
+ * Return: pointer to new array node, or NULL if out of memory
  */
 struct acpi_dp *acpi_dp_add_integer_array(struct acpi_dp *dp, const char *name,
 					  u64 *array, int len);
@@ -200,7 +200,7 @@ struct acpi_dp *acpi_dp_add_integer_array(struct acpi_dp *dp, const char *name,
  * @dp: Table to add this child to
  * @name: Name of child, or NULL for none
  * @child: Child node to add
- * @return pointer to new child node, or NULL if out of memory
+ * Return: pointer to new child node, or NULL if out of memory
  */
 struct acpi_dp *acpi_dp_add_child(struct acpi_dp *dp, const char *name,
 				  struct acpi_dp *child);
@@ -217,7 +217,7 @@ struct acpi_dp *acpi_dp_add_child(struct acpi_dp *dp, const char *name,
  * @index: Index of the GPIO resource in _CRS starting from zero
  * @pin: Pin in the GPIO resource, typically zero
  * @polarity: GPIO polarity. Note that ACPI_IRQ_ACTIVE_BOTH is not supported
- * @return pointer to new node, or NULL if out of memory
+ * Return: pointer to new node, or NULL if out of memory
  */
 struct acpi_dp *acpi_dp_add_gpio(struct acpi_dp *dp, const char *name,
 				 const char *ref, int index, int pin,
@@ -230,7 +230,7 @@ struct acpi_dp *acpi_dp_add_gpio(struct acpi_dp *dp, const char *name,
  *
  * @ctx: ACPI context
  * @table: Table to write
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int acpi_dp_write(struct acpi_ctx *ctx, struct acpi_dp *table);
 
@@ -242,7 +242,7 @@ int acpi_dp_write(struct acpi_ctx *ctx, struct acpi_dp *table);
  * @node: Node to copy from
  * @dp: DP to copy to
  * @prop: Property name to copy
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int acpi_dp_ofnode_copy_int(ofnode node, struct acpi_dp *dp, const char *prop);
 
@@ -254,7 +254,7 @@ int acpi_dp_ofnode_copy_int(ofnode node, struct acpi_dp *dp, const char *prop);
  * @node: Node to copy from
  * @dp: DP to copy to
  * @prop: Property name to copy
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int acpi_dp_ofnode_copy_str(ofnode node, struct acpi_dp *dp, const char *prop);
 
@@ -266,7 +266,7 @@ int acpi_dp_ofnode_copy_str(ofnode node, struct acpi_dp *dp, const char *prop);
  * @dev: Device to copy from
  * @dp: DP to copy to
  * @prop: Property name to copy
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int acpi_dp_dev_copy_int(const struct udevice *dev, struct acpi_dp *dp,
 			 const char *prop);
@@ -279,7 +279,7 @@ int acpi_dp_dev_copy_int(const struct udevice *dev, struct acpi_dp *dp,
  * @dev: Device to copy from
  * @dp: DP to copy to
  * @prop: Property name to copy
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int acpi_dp_dev_copy_str(const struct udevice *dev, struct acpi_dp *dp,
 			 const char *prop);
diff --git a/include/acpi/acpi_s3.h b/include/acpi/acpi_s3.h
index 847139baa0c..d3f271f948e 100644
--- a/include/acpi/acpi_s3.h
+++ b/include/acpi/acpi_s3.h
@@ -93,7 +93,7 @@ static inline enum acpi_sleep_state acpi_sleep_from_pm1(u32 pm1_cnt)
  * This returns chipset previous sleep state from ACPI registers.
  * Platform codes must supply this routine in order to support ACPI S3.
  *
- * @return ACPI_S0/S1/S2/S3/S4/S5.
+ * Return: ACPI_S0/S1/S2/S3/S4/S5.
  */
 enum acpi_sleep_state chipset_prev_sleep_state(void);
 
diff --git a/include/acpi/acpi_table.h b/include/acpi/acpi_table.h
index a28eb71f4d7..dbfea3be706 100644
--- a/include/acpi/acpi_table.h
+++ b/include/acpi/acpi_table.h
@@ -595,7 +595,7 @@ enum acpi_tables {
  * This keeps the version-number information in one place
  *
  * @table: ACPI table to check
- * @return version number that U-Boot generates
+ * Return: version number that U-Boot generates
  */
 int acpi_get_table_revision(enum acpi_tables table);
 
@@ -604,7 +604,7 @@ int acpi_get_table_revision(enum acpi_tables table);
  *
  * @dmar: Place to put the table
  * @flags: DMAR flags to use
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int acpi_create_dmar(struct acpi_dmar *dmar, enum dmar_flags flags);
 
@@ -674,7 +674,7 @@ void acpi_inc_align(struct acpi_ctx *ctx, uint amount);
  *
  * @ctx: ACPI context
  * @table: Table to add
- * @return 0 if OK, -E2BIG if too many tables
+ * Return: 0 if OK, -E2BIG if too many tables
  */
 int acpi_add_table(struct acpi_ctx *ctx, void *table);
 
diff --git a/include/acpi/acpigen.h b/include/acpi/acpigen.h
index 976f4dbb9af..2c269ed6627 100644
--- a/include/acpi/acpigen.h
+++ b/include/acpi/acpigen.h
@@ -140,7 +140,7 @@ struct acpi_tstate {
  * acpigen_get_current() - Get the current ACPI code output pointer
  *
  * @ctx: ACPI context pointer
- * @return output pointer
+ * Return: output pointer
  */
 u8 *acpigen_get_current(struct acpi_ctx *ctx);
 
@@ -428,7 +428,7 @@ void acpigen_write_scope(struct acpi_ctx *ctx, const char *scope);
  *
  * @ctx: ACPI context pointer
  * @uuid: UUID to write in the form aabbccdd-eeff-gghh-iijj-kkllmmnnoopp
- * @return 0 if OK, -EINVAL if the format is incorrect
+ * Return: 0 if OK, -EINVAL if the format is incorrect
  */
 int acpigen_write_uuid(struct acpi_ctx *ctx, const char *uuid);