From 70dee086a88cf3d26e7f2991475c834b61c0b3bb Mon Sep 17 00:00:00 2001 From: Jakub Rzeszutko Date: Wed, 2 Dec 2020 10:21:51 +0100 Subject: [PATCH] shell: api description update 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 --- include/shell/shell.h | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/include/shell/shell.h b/include/shell/shell.h index 7db6eba3b53..0589099ebeb 100644 --- a/include/shell/shell.h +++ b/include/shell/shell.h @@ -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, \