libs/rt-thread-official
libs
/
rt-thread-official
mirror of https://github.com/RT-Thread/rt-thread.git
4
0
Fork 0
Code Issues Releases Wiki Activity

[msh] add comments

This commit is contained in:
Meco Man 2021-09-05 12:07:35 -04:00
parent 877bb072cf
commit e4a404c3ef
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
components/finsh/finsh.h
View File

@ -116,15 +116,25 @@ typedef long (*syscall_func)(void);
#define FINSH_FUNCTION_EXPORT_ALIAS(name, alias, desc) #define FINSH_FUNCTION_EXPORT_ALIAS(name, alias, desc)
/** /**
* @ingroup finsh * @ingroup msh
* *
* This macro exports a command to module shell. * This macro exports a command to module shell.
* *
* @param command the name of command. * @param command is the name of the command.
* @param desc the description of command, which will show in help. * @param desc is the description of the command, which will show in help list.
*/ */
#define MSH_CMD_EXPORT(command, desc) \ #define MSH_CMD_EXPORT(command, desc) \
MSH_FUNCTION_EXPORT_CMD(command, command, desc) MSH_FUNCTION_EXPORT_CMD(command, command, desc)
/**
* @ingroup msh
*
* This macro exports a command with alias to module shell.
*
* @param command is the name of the command.
* @param alias is the alias of the command.
* @param desc is the description of the command, which will show in help list.
*/
#define MSH_CMD_EXPORT_ALIAS(command, alias, desc) \ #define MSH_CMD_EXPORT_ALIAS(command, alias, desc) \
MSH_FUNCTION_EXPORT_CMD(command, alias, desc) MSH_FUNCTION_EXPORT_CMD(command, alias, desc)