aboutsummaryrefslogtreecommitdiff
path: root/include/button.h
diff options
context:
space:
mode:
authorHeinrich Schuchardt2022-01-19 18:05:50 +0100
committerHeinrich Schuchardt2022-01-19 18:11:34 +0100
commit185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch)
tree2fea02768d6005934547f075586c60ba7aca6253 /include/button.h
parent6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff)
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/button.h')
-rw-r--r--include/button.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/include/button.h b/include/button.h
index ee14fadf0cf..96e6b1901fc 100644
--- a/include/button.h
+++ b/include/button.h
@@ -46,7 +46,7 @@ struct button_ops {
*
* @label: button 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 button_get_by_label(const char *label, struct udevice **devp);
@@ -54,7 +54,7 @@ int button_get_by_label(const char *label, struct udevice **devp);
* button_get_state() - get the state of a button
*
* @dev: button device to change
- * @return button state button_state_t, or -ve on error
+ * Return: button state button_state_t, or -ve on error
*/
enum button_state_t button_get_state(struct udevice *dev);