michaelh/zephyr
1
0
Fork 0
Code Releases Activity

shell: api description update

Browse source 
Update description of macros to create commands with mandatory
number of parameters. Added information that the command name is also
included in this number.

Signed-off-by: Jakub Rzeszutko <jakub.rzeszutko@nordicsemi.no>
This commit is contained in:
Jakub Rzeszutko 2020-12-02 10:21:51 +01:00 • committed by Anas Nashif
commit 70dee086a8
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
include/shell/shell.h
View file

@ -178,7 +178,7 @@ struct shell_static_entry {
* @param[in] subcmd Pointer to a subcommands array.
* @param[in] help Pointer to a command help string.
* @param[in] handler Pointer to a function handler.
* @param[in] mandatory Number of mandatory arguments.
* @param[in] mandatory Number of mandatory arguments includig command name.
* @param[in] optional Number of optional arguments.
*/
#define SHELL_CMD_ARG_REGISTER(syntax, subcmd, help, handler, \
@ -210,7 +210,7 @@ struct shell_static_entry {
* @param[in] subcmd Pointer to a subcommands array.
* @param[in] help Pointer to a command help string.
* @param[in] handler Pointer to a function handler.
* @param[in] mandatory Number of mandatory arguments.
* @param[in] mandatory Number of mandatory arguments includig command name.
* @param[in] optional Number of optional arguments.
*/
#define SHELL_COND_CMD_ARG_REGISTER(flag, syntax, subcmd, help, handler, \
@ -311,7 +311,7 @@ struct shell_static_entry {
* @param[in] subcmd Pointer to a subcommands array.
* @param[in] help Pointer to a command help string.
* @param[in] handler Pointer to a function handler.
* @param[in] mand Number of mandatory arguments.
* @param[in] mand Number of mandatory arguments includig command name.
* @param[in] opt Number of optional arguments.
*/
#define SHELL_CMD_ARG(syntax, subcmd, help, handler, mand, opt) \
@ -333,7 +333,7 @@ struct shell_static_entry {
* @param[in] subcmd Pointer to a subcommands array.
* @param[in] help Pointer to a command help string.
* @param[in] handler Pointer to a function handler.
* @param[in] mand Number of mandatory arguments.
* @param[in] mand Number of mandatory arguments includig command name.
* @param[in] opt Number of optional arguments.
*/
#define SHELL_COND_CMD_ARG(flag, syntax, subcmd, help, handler, mand, opt) \
@ -356,7 +356,7 @@ struct shell_static_entry {
* @param[in] _subcmd Pointer to a subcommands array.
* @param[in] _help Pointer to a command help string.
* @param[in] _handler Pointer to a function handler.
* @param[in] _mand Number of mandatory arguments.
* @param[in] _mand Number of mandatory arguments includig command name.
* @param[in] _opt Number of optional arguments.
*/
#define SHELL_EXPR_CMD_ARG(_expr, _syntax, _subcmd, _help, _handler, \