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>
diff --git a/include/cli.h b/include/cli.h
index 3449fa6..ba5b8eb 100644
--- a/include/cli.h
+++ b/include/cli.h
@@ -20,7 +20,7 @@
*
* @cmd: String containing the command to execute
* @flag Flag value - see CMD_FLAG_...
- * @return 1 - command executed, repeatable
+ * Return: 1 - command executed, repeatable
* 0 - command executed but not repeatable, interrupted commands are
* always considered not repeatable
* -1 - not executed (unrecognized, bootd recursion or too many args)
@@ -35,7 +35,7 @@
* @param input Input string possible containing $() / ${} vars
* @param output Output string with $() / ${} vars expanded
* @param max_size Maximum size of @output (including terminator)
- * @return 0 if OK, -ENOSPC if we ran out of space in @output
+ * Return: 0 if OK, -ENOSPC if we ran out of space in @output
*/
int cli_simple_process_macros(const char *input, char *output, int max_size);
@@ -50,7 +50,7 @@
*
* @param cmd String containing list of commands
* @param flag Execution flags (CMD_FLAG_...)
- * @return 0 on success, or != 0 on error.
+ * Return: 0 on success, or != 0 on error.
*/
int cli_simple_run_command_list(char *cmd, int flag);
@@ -60,7 +60,7 @@
* This is a convenience function which calls cli_readline_into_buffer().
*
* @prompt: Prompt to display
- * @return command line length excluding terminator, or -ve on error
+ * Return: command line length excluding terminator, or -ve on error
*/
int cli_readline(const char *const prompt);
@@ -82,7 +82,7 @@
* @prompt: Prompt to display
* @buffer: Place to put the line that is entered
* @timeout: Timeout in milliseconds, 0 if none
- * @return command line length excluding terminator, or -ve on error: of the
+ * Return: command line length excluding terminator, or -ve on error: of the
* timeout is exceeded (either CONFIG_BOOT_RETRY_TIME or the timeout
* parameter), then -2 is returned. If a break is detected (Ctrl-C) then
* -1 is returned.
@@ -105,7 +105,7 @@
*
* @line: Command line to parse
* @args: Array to hold arguments
- * @return number of arguments
+ * Return: number of arguments
*/
int cli_simple_parse_line(char *line, char *argv[]);
@@ -121,7 +121,7 @@
* @cmdp: On entry, the command that will be executed if the FDT does
* not have a command. Returns the command to execute after
* checking the FDT.
- * @return true to execute securely, else false
+ * Return: true to execute securely, else false
*/
bool cli_process_fdt(const char **cmdp);