michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: shell: update according to new help usage

Browse source 
Updated documentation according to recent changes:
1. Removed options from the shell.
2. Simplified help usage.

Signed-off-by: Jakub Rzeszutko <jakub.rzeszutko@nordicsemi.no>
This commit is contained in:
Jakub Rzeszutko 2018-11-26 22:39:43 +01:00 • committed by Carles Cufí
commit 9e958b405c
2 changed files with 28 additions and 132 deletions
Download patch file Download diff file Expand all files Collapse all files

13
include/shell/shell.h
View file

@ -105,10 +105,12 @@ struct shell_static_entry {
};
/**
* @brief Macro for defining and adding a root command (level 0) with
* arguments.
* @brief Macro for defining and adding a root command (level 0) with required
* number of arguments.
*
* @note Each root command shall have unique syntax.
* @note Each root command shall have unique syntax. If a command will be called
* with wrong number of arguments shell will print an error message and command
* handler will not be called.
*
* @param[in] syntax Command syntax (for example: history).
* @param[in] subcmd Pointer to a subcommands array.
@ -184,7 +186,10 @@ struct shell_static_entry {
}
/**
* @brief Initializes a shell command with arguments
* @brief Initializes a shell command with arguments.
*
* @note If a command will be called with wrong number of arguments shell will
* print an error message and command handler will not be called.
*
* @param[in] _syntax Command syntax (for example: history).
* @param[in] _subcmd Pointer to a subcommands array.