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>

3 files changed, 31 insertions, 31 deletions

diff --git a/include/power/acpi_pmc.h b/include/power/acpi_pmc.h
index 64176d79bc..62c4dcbd97 100644
--- a/include/power/acpi_pmc.h
+++ b/include/power/acpi_pmc.h
@@ -141,7 +141,7 @@ struct acpi_pmc_ops {
  * This reads the current state of the PMC. This reads in the common registers,
  * then calls the device's init() method to read the SoC-specific registers.
  *
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int pmc_init(struct udevice *dev);
 
@@ -151,7 +151,7 @@ int pmc_init(struct udevice *dev);
  * This reads various state registers and returns the sleep state from
  * which the system woke.
  *
- * @return enum acpi_sleep_state indicating the previous sleep state
+ * Return: enum acpi_sleep_state indicating the previous sleep state
  *	(ACPI_S0, ACPI_S3 or ACPI_S5), or -ve on error
  */
 int pmc_prev_sleep_state(struct udevice *dev);
@@ -162,7 +162,7 @@ int pmc_prev_sleep_state(struct udevice *dev);
  * Disables the timer/counter in the PMC
  *
  * @dev: PMC device to use
- * @return 0
+ * Return: 0
  */
 int pmc_disable_tco(struct udevice *dev);
 
@@ -176,7 +176,7 @@ int pmc_disable_tco(struct udevice *dev);
  *
  * @dev: PMC device to use
  * @enable: true to enable global reset, false to disable
- * @return 0
+ * Return: 0
  */
 int pmc_global_reset_set_enable(struct udevice *dev, bool enable);
 
@@ -190,7 +190,7 @@ void pmc_dump_info(struct udevice *dev);
  * pmc_gpe_init() - Set up general-purpose events
  *
  * @dev: PMC device
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int pmc_gpe_init(struct udevice *dev);
 
diff --git a/include/power/pmic.h b/include/power/pmic.h
index 97f855ce39..70f2709bd0 100644
--- a/include/power/pmic.h
+++ b/include/power/pmic.h
@@ -201,7 +201,7 @@ struct pmic_child_info {
  *
  * @pmic       - pmic device - the parent of found child's
  * @child_info - N-childs info array
- * @return a positive number of childs, or 0 if no child found (error)
+ * Return: a positive number of childs, or 0 if no child found (error)
  *
  * Note: For N-childs the child_info array should have N+1 entries and the last
  * entry prefix should be NULL - the same as for drivers compatible.
@@ -236,7 +236,7 @@ int pmic_bind_children(struct udevice *pmic, ofnode parent,
  *
  * @name - device name
  * @devp - returned pointer to the pmic device
- * @return 0 on success or negative value of errno.
+ * Return: 0 on success or negative value of errno.
  *
  * The returned devp device can be used with pmic_read/write calls
  */
@@ -248,7 +248,7 @@ int pmic_get(const char *name, struct udevice **devp);
  * The required pmic device can be obtained by 'pmic_get()'
  *
  * @dev - pointer to the UCLASS_PMIC device
- * @return register count value on success or negative value of errno.
+ * Return: register count value on success or negative value of errno.
  */
 int pmic_reg_count(struct udevice *dev);
 
@@ -261,7 +261,7 @@ int pmic_reg_count(struct udevice *dev);
  * @reg    - device register offset
  * @buffer - pointer to read/write buffer
  * @len    - byte count for read/write
- * @return 0 on success or negative value of errno.
+ * Return: 0 on success or negative value of errno.
  */
 int pmic_read(struct udevice *dev, uint reg, uint8_t *buffer, int len);
 int pmic_write(struct udevice *dev, uint reg, const uint8_t *buffer, int len);
@@ -271,7 +271,7 @@ int pmic_write(struct udevice *dev, uint reg, const uint8_t *buffer, int len);
  *
  * @dev:	PMIC device to read
  * @reg:	Register to read
- * @return value read on success or negative value of errno.
+ * Return: value read on success or negative value of errno.
  */
 int pmic_reg_read(struct udevice *dev, uint reg);
 
@@ -281,7 +281,7 @@ int pmic_reg_read(struct udevice *dev, uint reg);
  * @dev:	PMIC device to write
  * @reg:	Register to write
  * @value:	Value to write
- * @return 0 on success or negative value of errno.
+ * Return: 0 on success or negative value of errno.
  */
 int pmic_reg_write(struct udevice *dev, uint reg, uint value);
 
@@ -295,7 +295,7 @@ int pmic_reg_write(struct udevice *dev, uint reg, uint value);
  * @reg:	Register to update
  * @clr:	Bit mask to clear (set those bits that you want cleared)
  * @set:	Bit mask to set (set those bits that you want set)
- * @return 0 on success or negative value of errno.
+ * Return: 0 on success or negative value of errno.
  */
 int pmic_clrsetbits(struct udevice *dev, uint reg, uint clr, uint set);
 
diff --git a/include/power/regulator.h b/include/power/regulator.h
index fad87c99e5..ff1bfc2435 100644
--- a/include/power/regulator.h
+++ b/include/power/regulator.h
@@ -274,7 +274,7 @@ struct dm_regulator_ops {
  *
  * @dev        - pointer to the regulator device
  * @modep      - pointer to the returned mode info array
- * @return     - count of modep entries on success or negative errno if fail.
+ * Return:     - count of modep entries on success or negative errno if fail.
  */
 int regulator_mode(struct udevice *dev, struct dm_regulator_mode **modep);
 
@@ -282,7 +282,7 @@ int regulator_mode(struct udevice *dev, struct dm_regulator_mode **modep);
  * regulator_get_value: get microvoltage voltage value of a given regulator
  *
  * @dev    - pointer to the regulator device
- * @return - positive output value [uV] on success or negative errno if fail.
+ * Return: - positive output value [uV] on success or negative errno if fail.
  */
 int regulator_get_value(struct udevice *dev);
 
@@ -291,7 +291,7 @@ int regulator_get_value(struct udevice *dev);
  *
  * @dev    - pointer to the regulator device
  * @uV     - the output value to set [micro Volts]
- * @return - 0 on success or -errno val if fails
+ * Return: - 0 on success or -errno val if fails
  */
 int regulator_set_value(struct udevice *dev, int uV);
 
@@ -300,7 +300,7 @@ int regulator_set_value(struct udevice *dev, int uV);
  *
  * @dev    - pointer to the regulator device
  * @uV     - the output suspend value to set [micro Volts]
- * @return - 0 on success or -errno val if fails
+ * Return: - 0 on success or -errno val if fails
  */
 int regulator_set_suspend_value(struct udevice *dev, int uV);
 
@@ -308,7 +308,7 @@ int regulator_set_suspend_value(struct udevice *dev, int uV);
  * regulator_get_suspend_value: get the suspend microvoltage value of a given regulator.
  *
  * @dev    - pointer to the regulator device
- * @return - positive output value [uV] on success or negative errno if fail.
+ * Return: - positive output value [uV] on success or negative errno if fail.
  */
 int regulator_get_suspend_value(struct udevice *dev);
 
@@ -318,7 +318,7 @@ int regulator_get_suspend_value(struct udevice *dev);
  *
  * @dev    - pointer to the regulator device
  * @uV     - the output value to set [micro Volts]
- * @return - 0 on success or -errno val if fails
+ * Return: - 0 on success or -errno val if fails
  */
 int regulator_set_value_force(struct udevice *dev, int uV);
 
@@ -326,7 +326,7 @@ int regulator_set_value_force(struct udevice *dev, int uV);
  * regulator_get_current: get microampere value of a given regulator
  *
  * @dev    - pointer to the regulator device
- * @return - positive output current [uA] on success or negative errno if fail.
+ * Return: - positive output current [uA] on success or negative errno if fail.
  */
 int regulator_get_current(struct udevice *dev);
 
@@ -335,7 +335,7 @@ int regulator_get_current(struct udevice *dev);
  *
  * @dev    - pointer to the regulator device
  * @uA     - set the output current [micro Amps]
- * @return - 0 on success or -errno val if fails
+ * Return: - 0 on success or -errno val if fails
  */
 int regulator_set_current(struct udevice *dev, int uA);
 
@@ -343,7 +343,7 @@ int regulator_set_current(struct udevice *dev, int uA);
  * regulator_get_enable: get regulator device enable state.
  *
  * @dev    - pointer to the regulator device
- * @return - true/false of enable state or -errno val if fails
+ * Return: - true/false of enable state or -errno val if fails
  */
 int regulator_get_enable(struct udevice *dev);
 
@@ -352,7 +352,7 @@ int regulator_get_enable(struct udevice *dev);
  *
  * @dev    - pointer to the regulator device
  * @enable - set true or false
- * @return - 0 on success or -errno val if fails
+ * Return: - 0 on success or -errno val if fails
  */
 int regulator_set_enable(struct udevice *dev, bool enable);
 
@@ -362,7 +362,7 @@ int regulator_set_enable(struct udevice *dev, bool enable);
  *
  * @dev    - pointer to the regulator device
  * @enable - set true or false
- * @return - 0 on success or if enabling is not supported
+ * Return: - 0 on success or if enabling is not supported
  *	     -errno val if fails.
  */
 int regulator_set_enable_if_allowed(struct udevice *dev, bool enable);
@@ -372,7 +372,7 @@ int regulator_set_enable_if_allowed(struct udevice *dev, bool enable);
  *
  * @dev    - pointer to the regulator device
  * @enable - set true or false
- * @return - 0 on success or -errno val if fails
+ * Return: - 0 on success or -errno val if fails
  */
 int regulator_set_suspend_enable(struct udevice *dev, bool enable);
 
@@ -380,7 +380,7 @@ int regulator_set_suspend_enable(struct udevice *dev, bool enable);
  * regulator_get_suspend_enable: get regulator suspend enable state
  *
  * @dev    - pointer to the regulator device
- * @return - true/false of enable state or -errno val if fails
+ * Return: - true/false of enable state or -errno val if fails
  */
 int regulator_get_suspend_enable(struct udevice *dev);
 
@@ -388,7 +388,7 @@ int regulator_get_suspend_enable(struct udevice *dev);
  * regulator_get_mode: get active operation mode id of a given regulator
  *
  * @dev    - pointer to the regulator device
- * @return - positive mode 'id' number on success or -errno val if fails
+ * Return: - positive mode 'id' number on success or -errno val if fails
  * Note:
  * The device can provide an array of operating modes, which is type of struct
  * dm_regulator_mode. Each mode has it's own 'id', which should be unique inside
@@ -402,7 +402,7 @@ int regulator_get_mode(struct udevice *dev);
  *
  * @dev     - pointer to the regulator device
  * @mode_id - mode id to set ('id' field of struct type dm_regulator_mode)
- * @return  - 0 on success or -errno value if fails
+ * Return:  - 0 on success or -errno value if fails
  * Note:
  * The device can provide an array of operating modes, which is type of struct
  * dm_regulator_mode. Each mode has it's own 'id', which should be unique inside
@@ -493,7 +493,7 @@ int regulator_autoset_by_name(const char *platname, struct udevice **devp);
  * @list_devp     - an array of returned pointers to the successfully setup
  *                  regulator devices if non-NULL passed
  * @verbose       - (true/false) print each regulator setup info, or be quiet
- * @return 0 on successfully setup of all list entries, otherwise first error.
+ * Return: 0 on successfully setup of all list entries, otherwise first error.
  *
  * The returned 'regulator' devices can be used with:
  * - regulator_get/set_*
@@ -515,7 +515,7 @@ int regulator_list_autoset(const char *list_platname[],
  *
  * @devname - expected string for 'dev->name' of regulator device
  * @devp    - returned pointer to the regulator device
- * @return 0 on success or negative value of errno.
+ * Return: 0 on success or negative value of errno.
  *
  * The returned 'regulator' device is probed and can be used with:
  * - regulator_get/set_*
@@ -528,7 +528,7 @@ int regulator_get_by_devname(const char *devname, struct udevice **devp);
  *
  * @platname - expected string for uc_pdata->name of regulator uclass plat
  * @devp     - returns pointer to the regulator device or NULL on error
- * @return 0 on success or negative value of errno.
+ * Return: 0 on success or negative value of errno.
  *
  * The returned 'regulator' device is probed and can be used with:
  * - regulator_get/set_*
@@ -546,7 +546,7 @@ int regulator_get_by_platname(const char *platname, struct udevice **devp);
  * @dev         - device with supply phandle
  * @supply_name - phandle name of regulator
  * @devp        - returned pointer to the supply device
- * @return 0 on success or negative value of errno.
+ * Return: 0 on success or negative value of errno.
  */
 int device_get_supply_regulator(struct udevice *dev, const char *supply_name,
 				struct udevice **devp);