Fix ECC errors:1.Update the comments in function headers to follow the Doxygen specia...

[mirror_edk2.git] / ShellPkg / Application / Shell / Shell.c

diff --git a/ShellPkg/Application/Shell/Shell.c b/ShellPkg/Application/Shell/Shell.c
index ef821a5c5d021bc5ce20dfb8abb6ba37774af35b..0f5e069180c915d9a99a127c5fd465b9fc41ce79 100644 (file)
--- a/ShellPkg/Application/Shell/Shell.c
+++ b/ShellPkg/Application/Shell/Shell.c
@@ -71,9 +71,9 @@ STATIC CONST CHAR16 mExecutableExtensions[] = L".NSH;.EFI";
 STATIC CONST CHAR16 mStartupScript[]        = L"startup.nsh";\r
 \r
 /**\r
-  Cleans off leading and trailing spaces and tabs\r
+  Cleans off leading and trailing spaces and tabs.\r
 \r
-  @param[in] String pointer to the string to trim them off\r
+  @param[in] String pointer to the string to trim them off.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -107,8 +107,7 @@ TrimSpaces(
 \r
   @retval                 A pointer to the | character in CmdLine or NULL if not present.\r
 **/\r
-CONST\r
-CHAR16*\r
+CONST CHAR16*\r
 EFIAPI\r
 FindSplit(\r
   IN CONST CHAR16 *CmdLine\r
@@ -1432,13 +1431,12 @@ RunSplitCommand(
 \r
 /**\r
   Take the original command line, substitute any variables, free \r
-  the original string, return the modified copy\r
+  the original string, return the modified copy.\r
 \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
+  @param[in] CmdLine  pointer to the command line to update.\r
 \r
-  @retval EFI_SUCCESS           the function was successful\r
-  @retval EFI_OUT_OF_RESOURCES  a memory allocation failed\r
+  @retval EFI_SUCCESS           the function was successful.\r
+  @retval EFI_OUT_OF_RESOURCES  a memory allocation failed.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -1458,13 +1456,12 @@ ShellSubstituteVariables(
 \r
 /**\r
   Take the original command line, substitute any alias in the first group of space delimited characters, free \r
-  the original string, return the modified copy\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] CmdLine  pointer to the command line to update.\r
 \r
-  @retval EFI_SUCCESS           the function was successful\r
-  @retval EFI_OUT_OF_RESOURCES  a memory allocation failed\r
+  @retval EFI_SUCCESS           the function was successful.\r
+  @retval EFI_OUT_OF_RESOURCES  a memory allocation failed.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -1530,13 +1527,13 @@ ShellSubstituteAliases(
 /**\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
+  @param[in] CmdName  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
+  @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
@@ -1553,7 +1550,7 @@ GetOperationType(
   // test for an internal command.\r
   //\r
   if (ShellCommandIsCommandOnList(CmdName)) {\r
-    return (INTERNAL_COMMAND);\r
+    return (Internal_Command);\r
   }\r
 \r
   //\r
@@ -1561,9 +1558,9 @@ GetOperationType(
   //\r
   if (CmdName[(StrLen(CmdName)-1)] == L':') {\r
     if (StrStr(CmdName, L" ") != NULL) {\r
-      return (UNKNOWN_INVALID);\r
+      return (Unknown_Invalid);\r
     }\r
-    return (FILE_SYS_CHANGE);\r
+    return (File_Sys_Change);\r
   }\r
 \r
   //\r
@@ -1578,7 +1575,7 @@ GetOperationType(
       TempLocation2 = mScriptExtension;\r
       if (StringNoCaseCompare((VOID*)(&TempLocation), (VOID*)(&TempLocation2)) == 0) {\r
         SHELL_FREE_NON_NULL(FileWithPath);\r
-        return (SCRIPT_FILE_NAME);\r
+        return (Script_File_Name);\r
       }\r
     }\r
 \r
@@ -1586,14 +1583,14 @@ GetOperationType(
     // Was a file, but not a script.  we treat this as an application.\r
     //\r
     SHELL_FREE_NON_NULL(FileWithPath);\r
-    return (EFI_APPLICATION);\r
+    return (Efi_Application);\r
   }\r
   \r
   SHELL_FREE_NON_NULL(FileWithPath);\r
   //\r
   // No clue what this is... return invalid flag...\r
   //\r
-  return (UNKNOWN_INVALID);\r
+  return (Unknown_Invalid);\r
 }\r
 \r
 EFI_STATUS \r
@@ -1635,7 +1632,7 @@ IsValidSplit(
     TempWalker = (CHAR16*)Temp;\r
     GetNextParameter(&TempWalker, &FirstParameter);\r
 \r
-    if (GetOperationType(FirstParameter) == UNKNOWN_INVALID) {\r
+    if (GetOperationType(FirstParameter) == Unknown_Invalid) {\r
       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SHELL_NOT_FOUND), ShellInfoObject.HiiHandle, FirstParameter);\r
       SetLastError(SHELL_NOT_FOUND);\r
       Status = EFI_NOT_FOUND;\r
@@ -1648,7 +1645,7 @@ IsValidSplit(
 }\r
 \r
 /**\r
-  Determine if a command line contains with a split contains only valid commands\r
+  Determine if a command line contains with a split contains only valid commands.\r
 \r
   @param[in] CmdLine      The command line to parse.\r
 \r
@@ -1729,11 +1726,11 @@ ProcessNewSplitCommandLine(
 }\r
 \r
 /**\r
-  Handle a request to change the current file system\r
+  Handle a request to change the current file system.\r
 \r
-  @param[in] CmdLine  The passed in command line\r
+  @param[in] CmdLine  The passed in command line.\r
 \r
-  @retval EFI_SUCCESS The operation was successful\r
+  @retval EFI_SUCCESS The operation was successful.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -1816,9 +1813,9 @@ DoHelpUpdate(
 }\r
 \r
 /**\r
-  Function to update the shell variable "lasterror"\r
+  Function to update the shell variable "lasterror".\r
 \r
-  @param[in] ErrorCode      the error code to put into lasterror\r
+  @param[in] ErrorCode      the error code to put into lasterror.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -2006,11 +2003,11 @@ RunCommandOrFile(
   DevPath           = NULL;\r
 \r
   switch (Type) {\r
-    case   INTERNAL_COMMAND:\r
+    case   Internal_Command:\r
       Status = RunInternalCommand(CmdLine, FirstParameter, ParamProtocol);\r
       break;\r
-    case   SCRIPT_FILE_NAME:\r
-    case   EFI_APPLICATION:\r
+    case   Script_File_Name:\r
+    case   Efi_Application:\r
       //\r
       // Process a fully qualified path\r
       //\r
@@ -2041,10 +2038,10 @@ RunCommandOrFile(
         SetLastError(SHELL_NOT_FOUND);\r
       }\r
       switch (Type) {\r
-        case   SCRIPT_FILE_NAME:\r
+        case   Script_File_Name:\r
           Status = RunScriptFile (CommandWithPath);\r
           break;\r
-        case   EFI_APPLICATION:\r
+        case   Efi_Application:\r
           //\r
           // Get the device path of the application image\r
           //\r
@@ -2221,12 +2218,12 @@ RunCommand(
   // Depending on the first parameter we change the behavior\r
   //\r
   switch (Type = GetOperationType(FirstParameter)) {\r
-    case   FILE_SYS_CHANGE:\r
+    case   File_Sys_Change:\r
       Status = ChangeMappedDrive(CleanOriginal);\r
       break;\r
-    case   INTERNAL_COMMAND:\r
-    case   SCRIPT_FILE_NAME:\r
-    case   EFI_APPLICATION:\r
+    case   Internal_Command:\r
+    case   Script_File_Name:\r
+    case   Efi_Application:\r
       Status = SetupAndRunCommandOrFile(Type, CleanOriginal, FirstParameter, ShellInfoObject.NewShellParametersProtocol);\r
       break;\r
     default:\r