From e4a404c3efd19bbddc5ebdc14807d1702550c507 Mon Sep 17 00:00:00 2001
From: Meco Man <920369182@qq.com>
Date: Sun, 5 Sep 2021 12:07:35 -0400
Subject: [PATCH] [msh] add comments

---
 components/finsh/finsh.h | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

diff --git a/components/finsh/finsh.h b/components/finsh/finsh.h
index 380cade403..98048ebad4 100644
--- a/components/finsh/finsh.h
+++ b/components/finsh/finsh.h
@@ -116,15 +116,25 @@ typedef long (*syscall_func)(void);
 #define FINSH_FUNCTION_EXPORT_ALIAS(name, alias, desc)
 
 /**
- * @ingroup finsh
+ * @ingroup msh
  *
  * This macro exports a command to module shell.
  *
- * @param command the name of command.
- * @param desc the description of command, which will show in help.
+ * @param command is the name of the command.
+ * @param desc is the description of the command, which will show in help list.
  */
 #define MSH_CMD_EXPORT(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)  \
     MSH_FUNCTION_EXPORT_CMD(command, alias, desc)
 
-- 
GitLab