diff options
author | Heinrich Schuchardt | 2022-01-19 18:05:50 +0100 |
---|---|---|
committer | Heinrich Schuchardt | 2022-01-19 18:11:34 +0100 |
commit | 185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch) | |
tree | 2fea02768d6005934547f075586c60ba7aca6253 /include/cli.h | |
parent | 6a685753ce8b6b02b67d64b239143bf19eda63c9 (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/cli.h')
-rw-r--r-- | include/cli.h | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/include/cli.h b/include/cli.h index 3449fa6ae72..ba5b8ebd36e 100644 --- a/include/cli.h +++ b/include/cli.h @@ -20,7 +20,7 @@ void cli_simple_loop(void); * * @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 @@ int cli_simple_run_command(const char *cmd, int flag); * @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 @@ int cli_simple_process_macros(const char *input, char *output, int max_size); * * @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 @@ int cli_simple_run_command_list(char *cmd, int flag); * 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 @@ int cli_readline(const char *const prompt); * @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 @@ int cli_readline_into_buffer(const char *const prompt, char *buffer, * * @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 @@ int cli_simple_parse_line(char *line, char *argv[]); * @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); |