summaryrefslogtreecommitdiff
path: root/include/menu.h
diff options
context:
space:
mode:
authorHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-01-19 18:05:50 +0100
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-01-19 18:11:34 +0100
commit185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch)
tree2fea02768d6005934547f075586c60ba7aca6253 /include/menu.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/menu.h')
-rw-r--r--include/menu.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/include/menu.h b/include/menu.h
index 9ab9b21ebb..ad5859437e 100644
--- a/include/menu.h
+++ b/include/menu.h
@@ -30,7 +30,7 @@ int menu_default_choice(struct menu *m, void **choice);
*
* @bootdelay: Delay to wait before running the default menu option (0 to run
* the entry immediately)
- * @return If it returns, it always returns -1 to indicate that the boot should
+ * Return: If it returns, it always returns -1 to indicate that the boot should
* be aborted and the command prompt should be provided
*/
int menu_show(int bootdelay);