michaelh/zephyr
1
0
Fork 0
Code Releases Activity

shell: header file update

Browse source 
Minor formatting corrections in shell.h file.

Signed-off-by: Jakub Rzeszutko <jakub.rzeszutko@nordicsemi.no>
This commit is contained in:
Jakub Rzeszutko 2018-12-06 14:53:23 +01:00 • committed by Carles Cufí
commit 0c678fac9d
1 changed files with 88 additions and 88 deletions
Download patch file Download diff file Expand all files Collapse all files

6
include/shell/shell.h
View file

@ -135,7 +135,7 @@ struct shell_static_entry {
* @brief Macro for defining and adding a root command (level 0) with * @brief Macro for defining and adding a root command (level 0) with
* arguments. * arguments.
* *
* @note Each root command shall have unique syntax. * @note All root commands must have different name.
* *
* @param[in] syntax Command syntax (for example: history). * @param[in] syntax Command syntax (for example: history).
* @param[in] subcmd Pointer to a subcommands array. * @param[in] subcmd Pointer to a subcommands array.
@ -555,11 +555,11 @@ int shell_stop(const struct shell *shell);
#define SHELL_ERROR SHELL_VT100_COLOR_RED #define SHELL_ERROR SHELL_VT100_COLOR_RED
/** /**
* @brief Printf-like function which sends formatted data stream to the shell. * @brief printf-like function which sends formatted data stream to the shell.
* This function shall not be used outside of the shell command context. * This function shall not be used outside of the shell command context.
* *
* @param[in] shell Pointer to the shell instance. * @param[in] shell Pointer to the shell instance.
* @param[in] color Printf color. * @param[in] color Printed text color.
* @param[in] p_fmt Format string. * @param[in] p_fmt Format string.
* @param[in] ... List of parameters to print. * @param[in] ... List of parameters to print.
*/ */