summaryrefslogtreecommitdiff
path: root/include/led.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/led.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/led.h')
-rw-r--r--include/led.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/include/led.h b/include/led.h
index 02766fa56f..8eeb5a7c6d 100644
--- a/include/led.h
+++ b/include/led.h
@@ -78,7 +78,7 @@ struct led_ops {
*
* @label: LED label to look up
* @devp: Returns the associated device, if found
- * @return 0 if found, -ENODEV if not found, other -ve on error
+ * Return: 0 if found, -ENODEV if not found, other -ve on error
*/
int led_get_by_label(const char *label, struct udevice **devp);
@@ -87,7 +87,7 @@ int led_get_by_label(const char *label, struct udevice **devp);
*
* @dev: LED device to change
* @state: LED state to set
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int led_set_state(struct udevice *dev, enum led_state_t state);
@@ -95,7 +95,7 @@ int led_set_state(struct udevice *dev, enum led_state_t state);
* led_get_state() - get the state of an LED
*
* @dev: LED device to change
- * @return LED state led_state_t, or -ve on error
+ * Return: LED state led_state_t, or -ve on error
*/
enum led_state_t led_get_state(struct udevice *dev);
@@ -104,7 +104,7 @@ enum led_state_t led_get_state(struct udevice *dev);
*
* @dev: LED device to change
* @period_ms: LED blink period in milliseconds
- * @return 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
*/
int led_set_period(struct udevice *dev, int period_ms);