summaryrefslogtreecommitdiff
path: root/include/power-domain.h
diff options
context:
space:
mode:
authorHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-01-19 20:05:50 +0300
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-01-19 20:11:34 +0300
commit185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch)
tree2fea02768d6005934547f075586c60ba7aca6253 /include/power-domain.h
parent6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff)
downloadu-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.tar.xz
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>
Diffstat (limited to 'include/power-domain.h')
-rw-r--r--include/power-domain.h14
1 files changed, 7 insertions, 7 deletions
diff --git a/include/power-domain.h b/include/power-domain.h
index 62ff19948f..113276b511 100644
--- a/include/power-domain.h
+++ b/include/power-domain.h
@@ -74,7 +74,7 @@ struct power_domain {
*
* @dev: The client device.
* @power_domain A pointer to a power domain struct to initialize.
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
#if CONFIG_IS_ENABLED(POWER_DOMAIN)
int power_domain_get(struct udevice *dev, struct power_domain *power_domain);
@@ -93,7 +93,7 @@ int power_domain_get(struct udevice *dev, struct power_domain *power_domain)
* @power_domain: A pointer to a power domain struct to initialize.
* @index: Power domain index to be powered on.
*
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
#if CONFIG_IS_ENABLED(POWER_DOMAIN)
int power_domain_get_by_index(struct udevice *dev,
@@ -112,7 +112,7 @@ int power_domain_get_by_index(struct udevice *dev,
*
* @power_domain: A power domain struct that was previously successfully
* requested by power_domain_get().
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
#if CONFIG_IS_ENABLED(POWER_DOMAIN)
int power_domain_free(struct power_domain *power_domain);
@@ -128,7 +128,7 @@ static inline int power_domain_free(struct power_domain *power_domain)
*
* @power_domain: A power domain struct that was previously successfully
* requested by power_domain_get().
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
#if CONFIG_IS_ENABLED(POWER_DOMAIN)
int power_domain_on(struct power_domain *power_domain);
@@ -144,7 +144,7 @@ static inline int power_domain_on(struct power_domain *power_domain)
*
* @power_domain: A power domain struct that was previously successfully
* requested by power_domain_get().
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
#if CONFIG_IS_ENABLED(POWER_DOMAIN)
int power_domain_off(struct power_domain *power_domain);
@@ -160,7 +160,7 @@ static inline int power_domain_off(struct power_domain *power_domain)
*
* @dev: The client device.
*
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
#if CONFIG_IS_ENABLED(OF_REAL) && CONFIG_IS_ENABLED(POWER_DOMAIN)
int dev_power_domain_on(struct udevice *dev);
@@ -176,7 +176,7 @@ static inline int dev_power_domain_on(struct udevice *dev)
*
* @dev: The client device.
*
- * @return 0 if OK, or a negative error code.
+ * Return: 0 if OK, or a negative error code.
*/
#if CONFIG_IS_ENABLED(OF_REAL) && CONFIG_IS_ENABLED(POWER_DOMAIN)
int dev_power_domain_off(struct udevice *dev);