Skip to content

Commit e4a404c

Browse files
committed
[msh] add comments
1 parent 877bb07 commit e4a404c

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

components/finsh/finsh.h

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,15 +116,25 @@ typedef long (*syscall_func)(void);
116116
#define FINSH_FUNCTION_EXPORT_ALIAS(name, alias, desc)
117117

118118
/**
119-
* @ingroup finsh
119+
* @ingroup msh
120120
*
121121
* This macro exports a command to module shell.
122122
*
123-
* @param command the name of command.
124-
* @param desc the description of command, which will show in help.
123+
* @param command is the name of the command.
124+
* @param desc is the description of the command, which will show in help list.
125125
*/
126126
#define MSH_CMD_EXPORT(command, desc) \
127127
MSH_FUNCTION_EXPORT_CMD(command, command, desc)
128+
129+
/**
130+
* @ingroup msh
131+
*
132+
* This macro exports a command with alias to module shell.
133+
*
134+
* @param command is the name of the command.
135+
* @param alias is the alias of the command.
136+
* @param desc is the description of the command, which will show in help list.
137+
*/
128138
#define MSH_CMD_EXPORT_ALIAS(command, alias, desc) \
129139
MSH_FUNCTION_EXPORT_CMD(command, alias, desc)
130140

0 commit comments

Comments
 (0)