ShellPkg: Add missing function header comments

I found that some function headers had insufficient/incorrect information.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jaben Carsey <jaben.carsey@intel.com>
Reviewed-by: Erik Bjorge <erik.c.bjorge@intel.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@14998 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/ShellPkg/Application/Shell/Shell.c b/ShellPkg/Application/Shell/Shell.c
index 6822f52e814a07c978e9934c970cd18c7d629655..7a7bb1e736230b90bcbd37d0a23bd59010e6c8ff 100644 (file)
--- a/ShellPkg/Application/Shell/Shell.c
+++ b/ShellPkg/Application/Shell/Shell.c
@@ -1434,8 +1434,8 @@ RunSplitCommand(
   Take the original command line, substitute any variables, free \r
   the original string, return the modified copy\r
 \r
-  @param[in] CmdLine  pointer to the command line to update\r
-  @param[out]CmdName  upon successful return the name of the command to be run\r
+  @param[in,out] CmdLine  pointer to the command line to update\r
+  @param[out]CmdName      upon successful return the name of the command to be run\r
 \r
   @retval EFI_SUCCESS           the function was successful\r
   @retval EFI_OUT_OF_RESOURCES  a memory allocation failed\r
@@ -1529,6 +1529,14 @@ ShellSubstituteAliases(
 \r
 /**\r
   Takes the Argv[0] part of the command line and determine the meaning of it.\r
+\r
+  @param[in] CmdLine  pointer to the command line to update\r
+  \r
+  @retval INTERNAL_COMMAND    The name is an internal command\r
+  @retval FILE_SYS_CHANGE     the name is a file system change\r
+  @retval SCRIPT_FILE_NAME    the name is a NSH script file\r
+  @retval UNKNOWN_INVALID     the name is unknown\r
+  @retval EFI_APPLICATION     the name is an application (.EFI)\r
 **/\r
 SHELL_OPERATION_TYPES\r
 EFIAPI\r
@@ -1589,6 +1597,12 @@ GetOperationType(
 }\r
 \r
 /**\r
+  Process a split based operation.\r
+\r
+  @param[in] CmdLine    pointer to the command line to process\r
+\r
+  @retval EFI_SUCCESS   The operation was successful\r
+  @return               an error occured.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r