Refine comments and two code style.
authorydong10 <ydong10@6f19259b-4bc3-4df7-8a09-765794883524>
Fri, 2 Sep 2011 08:05:34 +0000 (08:05 +0000)
committerydong10 <ydong10@6f19259b-4bc3-4df7-8a09-765794883524>
Fri, 2 Sep 2011 08:05:34 +0000 (08:05 +0000)
Signed-off-by: ydong10
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@12263 6f19259b-4bc3-4df7-8a09-765794883524

51 files changed:
ShellPkg/Application/Shell/ConsoleLogger.h
ShellPkg/Application/Shell/ConsoleWrappers.c
ShellPkg/Application/Shell/FileHandleInternal.h
ShellPkg/Application/Shell/FileHandleWrappers.c
ShellPkg/Application/Shell/Shell.c
ShellPkg/Application/Shell/Shell.h
ShellPkg/Application/Shell/ShellEnvVar.c
ShellPkg/Application/Shell/ShellEnvVar.h
ShellPkg/Application/Shell/ShellManParser.c
ShellPkg/Application/Shell/ShellParametersProtocol.c
ShellPkg/Application/Shell/ShellParametersProtocol.h
ShellPkg/Application/Shell/ShellProtocol.c
ShellPkg/Application/Shell/ShellProtocol.h
ShellPkg/Application/ShellSortTestApp/ShellSortTestApp.c
ShellPkg/Include/Library/FileHandleLib.h
ShellPkg/Include/Library/PathLib.h
ShellPkg/Include/Library/ShellCommandLib.h
ShellPkg/Include/Library/ShellLib.h
ShellPkg/Include/Library/SortLib.h
ShellPkg/Include/Protocol/EfiShell.h
ShellPkg/Include/Protocol/EfiShellEnvironment2.h
ShellPkg/Library/BasePathLib/BasePathLib.c
ShellPkg/Library/BaseSortLib/BaseSortLib.c
ShellPkg/Library/UefiFileHandleLib/UefiFileHandleLib.c
ShellPkg/Library/UefiHandleParsingLib/UefiHandleParsingLib.c
ShellPkg/Library/UefiShellCommandLib/ConsistMapping.c
ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.c
ShellPkg/Library/UefiShellDebug1CommandsLib/Bcfg.c
ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.c
ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.h
ShellPkg/Library/UefiShellDebug1CommandsLib/Edit/FileBuffer.c
ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MainHexEditor.c
ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MemImage.c
ShellPkg/Library/UefiShellDebug1CommandsLib/Pci.c
ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.c
ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.h
ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/PrintInfo.c
ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.c
ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.h
ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.c
ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.h
ShellPkg/Library/UefiShellDriver1CommandsLib/Devices.c
ShellPkg/Library/UefiShellInstall1CommandsLib/Bcfg.c
ShellPkg/Library/UefiShellLevel1CommandsLib/For.c
ShellPkg/Library/UefiShellLevel1CommandsLib/If.c
ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.c
ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.h
ShellPkg/Library/UefiShellLevel2CommandsLib/Mv.c
ShellPkg/Library/UefiShellLib/UefiShellLib.c
ShellPkg/Library/UefiShellNetwork1CommandsLib/Ifconfig.c
ShellPkg/Library/UefiSortLib/UefiSortLib.c

index f7c5f6a..c470cdb 100644 (file)
@@ -80,7 +80,7 @@ ConsoleLoggerInstall(
   Return the system to the state it was before InstallConsoleLogger
   was installed.
 
-  @param[in,out] ConsoleInfo   The object from the install function.
+  @param[in, out] ConsoleInfo   The object from the install function.
 
   @retval EFI_SUCCESS     The operation was successful
   @return other           The operation failed.  This was from UninstallProtocolInterface.
index 3212af9..561a666 100644 (file)
@@ -81,8 +81,8 @@ FileBasedSimpleTextInReset(
 /**\r
   ReadKeyStroke function for the fake simple text input.\r
 \r
-  @param[in] This     A pointer to the SimpleTextIn structure.\r
-  @param[in,out] Key  A pointer to the Key structure to fill.\r
+  @param[in] This      A pointer to the SimpleTextIn structure.\r
+  @param[in, out] Key  A pointer to the Key structure to fill.\r
 \r
   @retval   EFI_SUCCESS The read was successful.\r
 **/\r
index ec55a6e..2aaae34 100644 (file)
@@ -19,8 +19,8 @@
   Move the cursor position one character backward.
 
   @param[in] LineLength       Length of a line. Get it by calling QueryMode
-  @param[in,out] Column      Current column of the cursor position
-  @param[in,out] Row         Current row of the cursor position
+  @param[in, out] Column      Current column of the cursor position
+  @param[in, out] Row         Current row of the cursor position
 **/
 VOID
 EFIAPI
@@ -35,8 +35,8 @@ MoveCursorBackward (
 
   @param[in] LineLength       Length of a line.
   @param[in] TotalRow         Total row of a screen
-  @param[in,out] Column      Current column of the cursor position
-  @param[in,out] Row         Current row of the cursor position
+  @param[in, out] Column      Current column of the cursor position
+  @param[in, out] Row         Current row of the cursor position
 **/
 VOID
 EFIAPI
index 22e8c71..2e1ce08 100644 (file)
@@ -95,10 +95,10 @@ FileInterfaceNopSetPosition(
 /**\r
   File style interface for console (GetInfo).\r
   \r
-  @param[in] This             Ignored.\r
-  @param[in] InformationType  Ignored.\r
-  @param[in,out] BufferSize   Ignored.\r
-  @param[out] Buffer          Ignored.\r
+  @param[in] This              Ignored.\r
+  @param[in] InformationType   Ignored.\r
+  @param[in, out] BufferSize   Ignored.\r
+  @param[out] Buffer           Ignored.\r
   \r
   @retval EFI_UNSUPPORTED\r
 **/\r
@@ -141,9 +141,9 @@ FileInterfaceNopSetInfo(
 \r
   Writes data to the screen.\r
   \r
-  @param[in] This             The pointer to the EFI_FILE_PROTOCOL object.\r
-  @param[in,out] BufferSize   Size in bytes of Buffer.\r
-  @param[in] Buffer           The pointer to the buffer to write.\r
+  @param[in] This              The pointer to the EFI_FILE_PROTOCOL object.\r
+  @param[in, out] BufferSize   Size in bytes of Buffer.\r
+  @param[in] Buffer            The pointer to the buffer to write.\r
   \r
   @retval EFI_UNSUPPORTED No output console is supported.\r
   @return A return value from gST->ConOut->OutputString.\r
@@ -166,9 +166,9 @@ FileInterfaceStdOutWrite(
 /**\r
   File style interface for StdIn (Write).\r
   \r
-  @param[in] This           Ignored.\r
-  @param[in,out] BufferSize Ignored.\r
-  @param[in] Buffer         Ignored.\r
+  @param[in] This            Ignored.\r
+  @param[in, out] BufferSize Ignored.\r
+  @param[in] Buffer          Ignored.\r
   \r
   @retval EFI_UNSUPPORTED\r
 **/\r
@@ -188,9 +188,9 @@ FileInterfaceStdInWrite(
 \r
   Writes error to the error output.\r
   \r
-  @param[in] This             The pointer to the EFI_FILE_PROTOCOL object.\r
-  @param[in,out] BufferSize   Size in bytes of Buffer.\r
-  @param[in] Buffer           The pointer to the buffer to write.\r
+  @param[in] This              The pointer to the EFI_FILE_PROTOCOL object.\r
+  @param[in, out] BufferSize   Size in bytes of Buffer.\r
+  @param[in] Buffer            The pointer to the buffer to write.\r
   \r
   @return A return value from gST->StdErr->OutputString.\r
 **/\r
@@ -208,9 +208,9 @@ FileInterfaceStdErrWrite(
 /**\r
   File style interface for console StdOut (Read).\r
   \r
-  @param[in] This             Ignored.\r
-  @param[in,out] BufferSize   Ignored.\r
-  @param[out] Buffer          Ignored.\r
+  @param[in] This              Ignored.\r
+  @param[in, out] BufferSize   Ignored.\r
+  @param[out] Buffer           Ignored.\r
   \r
   @retval EFI_UNSUPPORTED\r
 **/\r
@@ -228,9 +228,9 @@ FileInterfaceStdOutRead(
 /**\r
   File style interface for console StdErr (Read).\r
   \r
-  @param[in] This             Ignored.\r
-  @param[in,out] BufferSize   Ignored.\r
-  @param[out] Buffer          Ignored.\r
+  @param[in] This              Ignored.\r
+  @param[in, out] BufferSize   Ignored.\r
+  @param[out] Buffer           Ignored.\r
   \r
   @retval EFI_UNSUPPORTED Always.\r
 **/\r
@@ -248,9 +248,9 @@ FileInterfaceStdErrRead(
 /**\r
   File style interface for NUL file (Read).\r
   \r
-  @param[in] This             Ignored.\r
-  @param[in,out] BufferSize   Poiner to 0 upon return.\r
-  @param[out] Buffer          Ignored.\r
+  @param[in] This              Ignored.\r
+  @param[in, out] BufferSize   Poiner to 0 upon return.\r
+  @param[out] Buffer           Ignored.\r
   \r
   @retval EFI_SUCCESS Always.\r
 **/\r
@@ -269,9 +269,9 @@ FileInterfaceNulRead(
 /**\r
   File style interface for NUL file (Write).\r
   \r
-  @param[in] This             Ignored.\r
-  @param[in,out] BufferSize   Ignored.\r
-  @param[in] Buffer           Ignored.\r
+  @param[in] This              Ignored.\r
+  @param[in, out] BufferSize   Ignored.\r
+  @param[in] Buffer            Ignored.\r
   \r
   @retval EFI_SUCCESS\r
 **/\r
@@ -974,9 +974,9 @@ FileInterfaceEnvDelete(
 /**\r
   File style interface for Environment Variable (Read).\r
   \r
-  @param[in] This             The pointer to the EFI_FILE_PROTOCOL object.\r
-  @param[in,out] BufferSize   Size in bytes of Buffer.\r
-  @param[out] Buffer          The pointer to the buffer to fill.\r
+  @param[in] This              The pointer to the EFI_FILE_PROTOCOL object.\r
+  @param[in, out] BufferSize   Size in bytes of Buffer.\r
+  @param[out] Buffer           The pointer to the buffer to fill.\r
   \r
   @retval EFI_SUCCESS   The data was read.\r
 **/\r
@@ -997,9 +997,9 @@ FileInterfaceEnvRead(
 /**\r
   File style interface for Volatile Environment Variable (Write).\r
   \r
-  @param[in] This             The pointer to the EFI_FILE_PROTOCOL object.\r
-  @param[in,out] BufferSize   Size in bytes of Buffer.\r
-  @param[in] Buffer           The pointer to the buffer to write.\r
+  @param[in] This              The pointer to the EFI_FILE_PROTOCOL object.\r
+  @param[in, out] BufferSize   Size in bytes of Buffer.\r
+  @param[in] Buffer            The pointer to the buffer to write.\r
   \r
   @retval EFI_SUCCESS   The data was read.\r
 **/\r
@@ -1044,9 +1044,9 @@ FileInterfaceEnvVolWrite(
 /**\r
   File style interface for Non Volatile Environment Variable (Write).\r
   \r
-  @param[in] This             The pointer to the EFI_FILE_PROTOCOL object.\r
-  @param[in,out] BufferSize   Size in bytes of Buffer.\r
-  @param[in] Buffer           The pointer to the buffer to write.\r
+  @param[in] This              The pointer to the EFI_FILE_PROTOCOL object.\r
+  @param[in, out] BufferSize   Size in bytes of Buffer.\r
+  @param[in] Buffer            The pointer to the buffer to write.\r
   \r
   @retval EFI_SUCCESS   The data was read.\r
 **/\r
@@ -1144,8 +1144,8 @@ CreateFileInterfaceEnv(
   Move the cursor position one character backward.\r
 \r
   @param[in] LineLength       Length of a line. Get it by calling QueryMode\r
-  @param[in,out] Column      Current column of the cursor position\r
-  @param[in,out] Row         Current row of the cursor position\r
+  @param[in, out] Column      Current column of the cursor position\r
+  @param[in, out] Row         Current row of the cursor position\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -1174,8 +1174,8 @@ MoveCursorBackward (
 \r
   @param[in] LineLength       Length of a line.\r
   @param[in] TotalRow         Total row of a screen\r
-  @param[in,out] Column      Current column of the cursor position\r
-  @param[in,out] Row         Current row of the cursor position\r
+  @param[in, out] Column      Current column of the cursor position\r
+  @param[in, out] Row         Current row of the cursor position\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -1323,9 +1323,9 @@ FileInterfaceMemGetPosition(
 /**\r
   File style interface for Mem (Write).\r
   \r
-  @param[in] This             The pointer to the EFI_FILE_PROTOCOL object.\r
-  @param[in,out] BufferSize   Size in bytes of Buffer.\r
-  @param[in] Buffer           The pointer to the buffer to write.\r
+  @param[in] This              The pointer to the EFI_FILE_PROTOCOL object.\r
+  @param[in, out] BufferSize   Size in bytes of Buffer.\r
+  @param[in] Buffer            The pointer to the buffer to write.\r
   \r
   @retval EFI_SUCCESS   The data was written.\r
 **/\r
@@ -1369,9 +1369,9 @@ FileInterfaceMemWrite(
 /**\r
   File style interface for Mem (Read).\r
   \r
-  @param[in] This             The pointer to the EFI_FILE_PROTOCOL object.\r
-  @param[in,out] BufferSize   Size in bytes of Buffer.\r
-  @param[in] Buffer           The pointer to the buffer to fill.\r
+  @param[in] This              The pointer to the EFI_FILE_PROTOCOL object.\r
+  @param[in, out] BufferSize   Size in bytes of Buffer.\r
+  @param[in] Buffer            The pointer to the buffer to fill.\r
   \r
   @retval EFI_SUCCESS   The data was read.\r
 **/\r
@@ -1718,9 +1718,9 @@ FileInterfaceFileClose(
   If the file was opened with ASCII mode the data will be processed through \r
   AsciiSPrint before writing.\r
   \r
-  @param[in] This             The pointer to the EFI_FILE_PROTOCOL object.\r
-  @param[in,out] BufferSize   Size in bytes of Buffer.\r
-  @param[in] Buffer           The pointer to the buffer to write.\r
+  @param[in] This              The pointer to the EFI_FILE_PROTOCOL object.\r
+  @param[in, out] BufferSize   Size in bytes of Buffer.\r
+  @param[in] Buffer            The pointer to the buffer to write.\r
   \r
   @retval EFI_SUCCESS   The data was written.\r
 **/\r
index e817a11..3a5899f 100644 (file)
@@ -566,8 +566,8 @@ IsScriptOnlyCommand(
   loaded image protocol installed on it.  The FilePath will point to the device path\r
   for the file that was loaded.\r
 \r
-  @param[in,out] DevPath       On a sucessful return the device path to the loaded image.\r
-  @param[in,out] FilePath      On a sucessful return the device path to the file.\r
+  @param[in, out] DevPath       On a sucessful return the device path to the loaded image.\r
+  @param[in, out] FilePath      On a sucessful return the device path to the file.\r
 \r
   @retval EFI_SUCCESS           The 2 device paths were sucessfully returned.\r
   @retval other                 A error from gBS->HandleProtocol.\r
@@ -1016,10 +1016,10 @@ AddLineToCommandHistory(
   Checks if a string is an alias for another command.  If yes, then it replaces the alias name\r
   with the correct command name.\r
 \r
-  @param[in,out] CommandString    Upon entry the potential alias.  Upon return the\r
-                                  command name if it was an alias.  If it was not\r
-                                  an alias it will be unchanged.  This function may\r
-                                  change the buffer to fit the command name.\r
+  @param[in, out] CommandString    Upon entry the potential alias.  Upon return the\r
+                                   command name if it was an alias.  If it was not\r
+                                   an alias it will be unchanged.  This function may\r
+                                   change the buffer to fit the command name.\r
 \r
   @retval EFI_SUCCESS             The name was changed.\r
   @retval EFI_SUCCESS             The name was not an alias.\r
index e79c548..d01b126 100644 (file)
@@ -137,8 +137,8 @@ SetBuiltInAlias(
   loaded image protocol installed on it.  the FilePath will point to the device path\r
   for the file that was loaded.\r
 \r
-  @param[in,out] DevPath       on a sucessful return the device path to the loaded image\r
-  @param[in,out] FilePath      on a sucessful return the device path to the file\r
+  @param[in, out] DevPath       on a sucessful return the device path to the loaded image\r
+  @param[in, out] FilePath      on a sucessful return the device path to the file\r
 \r
   @retval EFI_SUCCESS           the 2 device paths were sucessfully returned.\r
   @return other                 a error from gBS->HandleProtocol\r
index d674f14..a4bd6a6 100644 (file)
@@ -123,8 +123,8 @@ FreeEnvironmentVariableList(
 /**\r
   Creates a list of all Shell-Guid-based environment variables.\r
 \r
-  @param[in,out] ListHead       The pointer to pointer to LIST ENTRY object for\r
-                                storing this list.\r
+  @param[in, out] ListHead       The pointer to pointer to LIST ENTRY object for\r
+                                 storing this list.\r
 \r
   @retval EFI_SUCCESS           the list was created sucessfully.\r
 **/\r
index 2778959..ab3d916 100644 (file)
@@ -145,8 +145,8 @@ IsVolatileEnv (
 /**\r
   Creates a list of all Shell-Guid-based environment variables.\r
 \r
-  @param[in,out] List           The pointer to pointer to LIST_ENTRY object for\r
-                                storing this list.\r
+  @param[in, out] List           The pointer to pointer to LIST_ENTRY object for\r
+                                 storing this list.\r
 \r
   @retval EFI_SUCCESS           the list was created sucessfully.\r
 **/\r
index ab32c36..bcc1f8e 100644 (file)
@@ -423,12 +423,12 @@ ManBufferFindTitleSection(
 \r
   Upon a sucessful return the caller is responsible to free the memory in *BriefDesc\r
 \r
-  @param[in] Handle             FileHandle to read from\r
-  @param[in] Command            name of command's section to find\r
-  @param[out] BriefDesc         pointer to pointer to string where description goes.\r
-  @param[out] BriefSize         pointer to size of allocated BriefDesc\r
-  @param[in,out] Ascii          TRUE if the file is ASCII, FALSE otherwise, will be\r
-                                set if the file handle is at the 0 position.\r
+  @param[in] Handle              FileHandle to read from\r
+  @param[in] Command             name of command's section to find\r
+  @param[out] BriefDesc          pointer to pointer to string where description goes.\r
+  @param[out] BriefSize          pointer to size of allocated BriefDesc\r
+  @param[in, out] Ascii          TRUE if the file is ASCII, FALSE otherwise, will be\r
+                                 set if the file handle is at the 0 position.\r
 \r
   @retval EFI_OUT_OF_RESOURCES  a memory allocation failed.\r
   @retval EFI_SUCCESS           the section was found and its description sotred in\r
index 99a7294..02606d6 100644 (file)
@@ -26,9 +26,9 @@
   Temp Parameter must be large enough to hold the parameter before calling this\r
   function.\r
 \r
-  @param[in,out] Walker        pointer to string of command line.  Adjusted to\r
+  @param[in, out] Walker        pointer to string of command line.  Adjusted to\r
                                 reminaing command line on return\r
-  @param[in,out] TempParameter pointer to string of command line item extracted.\r
+  @param[in, out] TempParameter pointer to string of command line item extracted.\r
 \r
 **/\r
 VOID\r
@@ -137,9 +137,9 @@ GetNextParameter(
   parameters for inclusion in EFI_SHELL_PARAMETERS_PROTOCOL.  this supports space\r
   delimited and quote surrounded parameter definition.\r
 \r
-  @param[in] CommandLine        String of command line to parse\r
-  @param[in,out] Argv           pointer to array of strings; one for each parameter\r
-  @param[in,out] Argc           pointer to number of strings in Argv array\r
+  @param[in] CommandLine         String of command line to parse\r
+  @param[in, out] Argv           pointer to array of strings; one for each parameter\r
+  @param[in, out] Argc           pointer to number of strings in Argv array\r
 \r
   @return EFI_SUCCESS           the operation was sucessful\r
   @return EFI_OUT_OF_RESOURCES  a memory allocation failed.\r
@@ -215,9 +215,9 @@ ParseCommandLineToArgs(
   installs it on our handle and if there is an existing version of the protocol\r
   that one is cached for removal later.\r
 \r
-  @param[in,out] NewShellParameters on a successful return, a pointer to pointer\r
+  @param[in, out] NewShellParameters on a successful return, a pointer to pointer\r
                                      to the newly installed interface.\r
-  @param[in,out] RootShellInstance  on a successful return, pointer to boolean.\r
+  @param[in, out] RootShellInstance  on a successful return, pointer to boolean.\r
                                      TRUE if this is the root shell instance.\r
 \r
   @retval EFI_SUCCESS               the operation completed successfully.\r
@@ -449,7 +449,7 @@ IsUnicodeFile(
 \r
   All of the characters between quotes is replaced with spaces.\r
 \r
-  @param[in,out] TheString  A pointer to the string to update.\r
+  @param[in, out] TheString  A pointer to the string to update.\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -477,12 +477,12 @@ StripQuotes (
 \r
   This will also update the system table.\r
 \r
-  @param[in,out] ShellParameters        Pointer to parameter structure to modify.\r
-  @param[in] NewCommandLine             The new command line to parse and use.\r
-  @param[out] OldStdIn                  Pointer to old StdIn.\r
-  @param[out] OldStdOut                 Pointer to old StdOut.\r
-  @param[out] OldStdErr                 Pointer to old StdErr.\r
-  @param[out] SystemTableInfo           Pointer to old system table information.\r
+  @param[in, out] ShellParameters        Pointer to parameter structure to modify.\r
+  @param[in] NewCommandLine              The new command line to parse and use.\r
+  @param[out] OldStdIn                   Pointer to old StdIn.\r
+  @param[out] OldStdOut                  Pointer to old StdOut.\r
+  @param[out] OldStdErr                  Pointer to old StdErr.\r
+  @param[out] SystemTableInfo            Pointer to old system table information.\r
 \r
   @retval   EFI_SUCCESS                 Operation was sucessful, Argv and Argc are valid.\r
   @retval   EFI_OUT_OF_RESOURCES        A memory allocation failed.\r
@@ -1049,11 +1049,11 @@ UpdateStdInStdOutStdErr(
   Funcion will replace the current StdIn and StdOut in the ShellParameters protocol\r
   structure with StdIn and StdOut.  The current values are de-allocated.\r
 \r
-  @param[in,out] ShellParameters      Pointer to parameter structure to modify.\r
-  @param[in] OldStdIn                 Pointer to old StdIn.\r
-  @param[in] OldStdOut                Pointer to old StdOut.\r
-  @param[in] OldStdErr                Pointer to old StdErr.\r
-  @param[in] SystemTableInfo          Pointer to old system table information.\r
+  @param[in, out] ShellParameters      Pointer to parameter structure to modify.\r
+  @param[in] OldStdIn                  Pointer to old StdIn.\r
+  @param[in] OldStdOut                 Pointer to old StdOut.\r
+  @param[in] OldStdErr                 Pointer to old StdErr.\r
+  @param[in] SystemTableInfo           Pointer to old system table information.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -1121,10 +1121,10 @@ RestoreStdInStdOutStdErr (
 \r
   If OldArgv or OldArgc is NULL then that value is not returned.\r
 \r
-  @param[in,out] ShellParameters        Pointer to parameter structure to modify.\r
-  @param[in] NewCommandLine             The new command line to parse and use.\r
-  @param[out] OldArgv                   Pointer to old list of parameters.\r
-  @param[out] OldArgc                   Pointer to old number of items in Argv list.\r
+  @param[in, out] ShellParameters        Pointer to parameter structure to modify.\r
+  @param[in] NewCommandLine              The new command line to parse and use.\r
+  @param[out] OldArgv                    Pointer to old list of parameters.\r
+  @param[out] OldArgc                    Pointer to old number of items in Argv list.\r
 \r
   @retval   EFI_SUCCESS                 Operation was sucessful, Argv and Argc are valid.\r
   @retval   EFI_OUT_OF_RESOURCES        A memory allocation failed.\r
@@ -1155,9 +1155,9 @@ UpdateArgcArgv(
   structure with Argv and Argc.  The current values are de-allocated and the\r
   OldArgv must not be deallocated by the caller.\r
 \r
-  @param[in,out] ShellParameters       pointer to parameter structure to modify\r
-  @param[in] OldArgv                   pointer to old list of parameters\r
-  @param[in] OldArgc                   pointer to old number of items in Argv list\r
+  @param[in, out] ShellParameters       pointer to parameter structure to modify\r
+  @param[in] OldArgv                    pointer to old list of parameters\r
+  @param[in] OldArgc                    pointer to old number of items in Argv list\r
 **/\r
 VOID\r
 EFIAPI\r
index df3bfa7..b63e1d3 100644 (file)
@@ -43,9 +43,9 @@
   installs it on our handle and if there is an existing version of the protocol\r
   that one is cached for removal later.\r
 \r
-  @param[in,out] NewShellParameters on a successful return, a pointer to pointer\r
+  @param[in, out] NewShellParameters on a successful return, a pointer to pointer\r
                                      to the newly installed interface.\r
-  @param[in,out] RootShellInstance  on a successful return, pointer to boolean.\r
+  @param[in, out] RootShellInstance  on a successful return, pointer to boolean.\r
                                      TRUE if this is the root shell instance.\r
 \r
   @retval EFI_SUCCESS               the operation completed successfully.\r
@@ -84,7 +84,7 @@ CleanUpShellParametersProtocol (
   structure by parsing NewCommandLine.  The current values are returned to the\r
   user.\r
 \r
-  @param[in,out] ShellParameters       pointer to parameter structure to modify\r
+  @param[in, out] ShellParameters       pointer to parameter structure to modify\r
   @param[in] NewCommandLine             the new command line to parse and use\r
   @param[out] OldArgv                   pointer to old list of parameters\r
   @param[out] OldArgc                   pointer to old number of items in Argv list\r
@@ -106,9 +106,9 @@ UpdateArgcArgv(
   structure with Argv and Argc.  The current values are de-allocated and the\r
   OldArgv must not be deallocated by the caller.\r
 \r
-  @param[in,out] ShellParameters       pointer to parameter structure to modify\r
-  @param[in] OldArgv                   pointer to old list of parameters\r
-  @param[in] OldArgc                   pointer to old number of items in Argv list\r
+  @param[in, out] ShellParameters       pointer to parameter structure to modify\r
+  @param[in] OldArgv                    pointer to old list of parameters\r
+  @param[in] OldArgc                    pointer to old number of items in Argv list\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -134,12 +134,12 @@ typedef struct {
 \r
   This will also update the system table.\r
 \r
-  @param[in,out] ShellParameters        Pointer to parameter structure to modify.\r
-  @param[in] NewCommandLine             The new command line to parse and use.\r
-  @param[out] OldStdIn                  Pointer to old StdIn.\r
-  @param[out] OldStdOut                 Pointer to old StdOut.\r
-  @param[out] OldStdErr                 Pointer to old StdErr.\r
-  @param[out] SystemTableInfo           Pointer to old system table information.\r
+  @param[in, out] ShellParameters        Pointer to parameter structure to modify.\r
+  @param[in] NewCommandLine              The new command line to parse and use.\r
+  @param[out] OldStdIn                   Pointer to old StdIn.\r
+  @param[out] OldStdOut                  Pointer to old StdOut.\r
+  @param[out] OldStdErr                  Pointer to old StdErr.\r
+  @param[out] SystemTableInfo            Pointer to old system table information.\r
 \r
   @retval   EFI_SUCCESS                 Operation was sucessful, Argv and Argc are valid.\r
   @retval   EFI_OUT_OF_RESOURCES        A memory allocation failed.\r
@@ -159,11 +159,11 @@ UpdateStdInStdOutStdErr(
   Funcion will replace the current StdIn and StdOut in the ShellParameters protocol\r
   structure with StdIn and StdOut.  The current values are de-allocated.\r
 \r
-  @param[in,out] ShellParameters      Pointer to parameter structure to modify.\r
-  @param[in] OldStdIn                 Pointer to old StdIn.\r
-  @param[in] OldStdOut                Pointer to old StdOut.\r
-  @param[in] OldStdErr                Pointer to old StdErr.\r
-  @param[in] SystemTableInfo          Pointer to old system table information.\r
+  @param[in, out] ShellParameters      Pointer to parameter structure to modify.\r
+  @param[in] OldStdIn                  Pointer to old StdIn.\r
+  @param[in] OldStdOut                 Pointer to old StdOut.\r
+  @param[in] OldStdErr                 Pointer to old StdErr.\r
+  @param[in] SystemTableInfo           Pointer to old system table information.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -182,9 +182,9 @@ RestoreStdInStdOutStdErr (
   parameters for inclusion in EFI_SHELL_PARAMETERS_PROTOCOL.  this supports space\r
   delimited and quote surrounded parameter definition.\r
 \r
-  @param[in] CommandLine        String of command line to parse\r
-  @param[in,out] Argv           pointer to array of strings; one for each parameter\r
-  @param[in,out] Argc           pointer to number of strings in Argv array\r
+  @param[in] CommandLine         String of command line to parse\r
+  @param[in, out] Argv           pointer to array of strings; one for each parameter\r
+  @param[in, out] Argc           pointer to number of strings in Argv array\r
 \r
   @return EFI_SUCCESS           the operation was sucessful\r
   @return EFI_OUT_OF_RESOURCES  a memory allocation failed.\r
@@ -207,9 +207,9 @@ ParseCommandLineToArgs(
   Temp Parameter must be large enough to hold the parameter before calling this\r
   function.\r
 \r
-  @param[in,out] Walker        pointer to string of command line.  Adjusted to\r
+  @param[in, out] Walker        pointer to string of command line.  Adjusted to\r
                                 reminaing command line on return\r
-  @param[in,out] TempParameter pointer to string of command line item extracted.\r
+  @param[in, out] TempParameter pointer to string of command line item extracted.\r
 \r
 **/\r
 VOID\r
index e42f081..ee40e40 100644 (file)
@@ -1945,8 +1945,8 @@ EfiShellFindFilesInDir(
 /**\r
   Updates a file name to be preceeded by the mapped drive name\r
 \r
-  @param[in] BasePath     the Mapped drive name to prepend\r
-  @param[in,out] Path     pointer to pointer to the file name to update.\r
+  @param[in] BasePath      the Mapped drive name to prepend\r
+  @param[in, out] Path     pointer to pointer to the file name to update.\r
 \r
   @retval EFI_SUCCESS\r
   @retval EFI_OUT_OF_RESOURCES\r
@@ -2001,12 +2001,12 @@ UpdateFileName(
   Upon a EFI_SUCCESS return fromt he function any the caller is responsible to call\r
   FreeFileList with FileList.\r
 \r
-  @param[in] FilePattern        The FilePattern to check against.\r
-  @param[in] UnicodeCollation   The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure\r
-  @param[in] FileHandle         The FileHandle to start with\r
-  @param[in,out] FileList       pointer to pointer to list of found files.\r
-  @param[in] ParentNode         The node for the parent. Same file as identified by HANDLE.\r
-  @param[in] MapName            The file system name this file is on.\r
+  @param[in] FilePattern         The FilePattern to check against.\r
+  @param[in] UnicodeCollation    The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure\r
+  @param[in] FileHandle          The FileHandle to start with\r
+  @param[in, out] FileList       pointer to pointer to list of found files.\r
+  @param[in] ParentNode          The node for the parent. Same file as identified by HANDLE.\r
+  @param[in] MapName             The file system name this file is on.\r
 \r
   @retval EFI_SUCCESS           all files were found and the FileList contains a list.\r
   @retval EFI_NOT_FOUND         no files were found\r
@@ -3124,7 +3124,7 @@ EFI_SHELL_PROTOCOL         mShellProtocol = {
 \r
   This must be removed via calling CleanUpShellProtocol().\r
 \r
-  @param[in,out] NewShell   The pointer to the pointer to the structure\r
+  @param[in, out] NewShell   The pointer to the pointer to the structure\r
   to install.\r
 \r
   @retval EFI_SUCCESS     The operation was successful.\r
@@ -3253,7 +3253,7 @@ CreatePopulateInstallShellProtocol (
   Free all memory and restore the system to the state it was in before calling\r
   CreatePopulateInstallShellProtocol.\r
 \r
-  @param[in,out] NewShell   The pointer to the new shell protocol structure.\r
+  @param[in, out] NewShell   The pointer to the new shell protocol structure.\r
 \r
   @retval EFI_SUCCESS       The operation was successful.\r
 **/\r
index 1b809ec..a63ae8f 100644 (file)
@@ -68,7 +68,7 @@ typedef struct {
 \r
   This must be removed via calling CleanUpShellProtocol().\r
 \r
-  @param[in,out] NewShell   The pointer to the pointer to the structure \r
+  @param[in, out] NewShell   The pointer to the pointer to the structure \r
   to install.\r
 \r
   @retval EFI_SUCCESS     The operation was successful.\r
@@ -86,7 +86,7 @@ CreatePopulateInstallShellProtocol (
   Free all memory and restore the system to the state it was in before calling\r
   CreatePopulateInstallShellProtocol.\r
 \r
-  @param[in,out] NewShell   The pointer to the new shell protocol structure.\r
+  @param[in, out] NewShell   The pointer to the new shell protocol structure.\r
 \r
   @retval EFI_SUCCESS       The operation was successful.\r
 **/\r
index 91817ee..d1a0568 100644 (file)
@@ -38,8 +38,8 @@ Test(CONST VOID*b1, CONST VOID*b2)
   The ShellCEntryLib library instance wrappers the actual UEFI application\r
   entry point and calls this ShellAppMain function.\r
 \r
-  @param  ImageHandle  The image handle of the UEFI Application.\r
-  @param  SystemTable  A pointer to the EFI System Table.\r
+  @param  Argc             Argument count\r
+  @param  Argv             The parsed arguments\r
 \r
   @retval  0               The application exited normally.\r
   @retval  Other           An error occurred.\r
index b4c2e7d..a21e20e 100644 (file)
@@ -82,10 +82,10 @@ FileHandleSetInfo (
   are no more directory entries, the read returns a zero-length buffer.\r
   EFI_FILE_INFO is the structure returned as the directory entry.\r
 \r
-  @param[in] FileHandle         The opened file handle.\r
-  @param[in,out] BufferSize     On input, the size of buffer in bytes.  On return,\r
-                                the number of bytes written.\r
-  @param[out] Buffer            The buffer to put read data into.\r
+  @param[in] FileHandle          The opened file handle.\r
+  @param[in, out] BufferSize     On input, the size of buffer in bytes.  On return,\r
+                                 the number of bytes written.\r
+  @param[out] Buffer             The buffer to put read data into.\r
 \r
   @retval EFI_SUCCESS          Data was read.\r
   @retval EFI_NO_MEDIA         The device has no media.\r
@@ -113,10 +113,10 @@ FileHandleRead(
   The file is automatically grown to hold the data if required. Direct writes to\r
   opened directories are not supported.\r
 \r
-  @param[in] FileHandle         The opened file for writing.\r
-  @param[in,out] BufferSize     On input, the number of bytes in Buffer.  On output,\r
-                                the number of bytes written.\r
-  @param[in] Buffer             The buffer containing data to write is stored.\r
+  @param[in] FileHandle          The opened file for writing.\r
+  @param[in, out] BufferSize     On input, the number of bytes in Buffer.  On output,\r
+                                 the number of bytes written.\r
+  @param[in] Buffer              The buffer containing data to write is stored.\r
 \r
   @retval EFI_SUCCESS          Data was written.\r
   @retval EFI_UNSUPPORTED       Writes to an open directory are not supported.\r
@@ -379,17 +379,17 @@ FileHandleGetFileName (
   If the position upon start is 0, then the Ascii Boolean will be set.  This should be\r
   maintained and not changed for all operations with the same file.\r
 \r
-  @param[in]      Handle        FileHandle to read from.\r
-  @param[in,out]  Buffer        The pointer to buffer to read into.\r
-  @param[in,out]  Size          The pointer to number of bytes in Buffer.\r
-  @param[in]      Truncate      If the buffer is large enough, this has no effect.\r
-                                If the buffer is is too small and Truncate is TRUE,\r
-                                the line will be truncated.\r
-                                If the buffer is is too small and Truncate is FALSE,\r
-                                then no read will occur.\r
+  @param[in]       Handle        FileHandle to read from.\r
+  @param[in, out]  Buffer        The pointer to buffer to read into.\r
+  @param[in, out]  Size          The pointer to number of bytes in Buffer.\r
+  @param[in]       Truncate      If the buffer is large enough, this has no effect.\r
+                                 If the buffer is is too small and Truncate is TRUE,\r
+                                 the line will be truncated.\r
+                                 If the buffer is is too small and Truncate is FALSE,\r
+                                 then no read will occur.\r
 \r
-  @param[in,out]  Ascii         Boolean value for indicating whether the file is\r
-                                Ascii (TRUE) or UCS2 (FALSE).\r
+  @param[in, out]  Ascii         Boolean value for indicating whether the file is\r
+                                 Ascii (TRUE) or UCS2 (FALSE).\r
 \r
   @retval EFI_SUCCESS           The operation was successful.  The line is stored in\r
                                 Buffer.\r
@@ -416,9 +416,9 @@ FileHandleReadLine(
   If the position upon start is 0, then the Ascii Boolean will be set.  This should be\r
   maintained and not changed for all operations with the same file.\r
 \r
-  @param[in]      Handle        FileHandle to read from.\r
-  @param[in,out]  Ascii         Boolean value for indicating whether the file is\r
-                                Ascii (TRUE) or UCS2 (FALSE).\r
+  @param[in]       Handle        FileHandle to read from.\r
+  @param[in, out]  Ascii         Boolean value for indicating whether the file is\r
+                                 Ascii (TRUE) or UCS2 (FALSE).\r
 \r
   @return                       The line of text from the file.\r
 \r
index 912b1f1..ee47352 100644 (file)
@@ -21,7 +21,7 @@
   Removes the last directory or file entry in a path by changing the last\r
   L'\' to a CHAR_NULL.\r
 \r
-  @param[in,out] Path    The pointer to the path to modify.\r
+  @param[in, out] Path    The pointer to the path to modify.\r
 \r
   @retval FALSE     Nothing was found to remove.\r
   @retval TRUE      A directory or file was removed.\r
index 5bc03ce..f453d22 100644 (file)
@@ -159,12 +159,12 @@ ShellCommandRegisterCommandName (
   information is returned. If Sections is NULL, then all help text information\r
   available is returned.\r
 \r
-  @param[in]  CommandString         The pointer to the command name.  This is the name\r
-                                    found on the command line in the shell.\r
-  @param[in,out] RetVal             The pointer to the return value from the command handler.\r
+  @param[in]   CommandString         The pointer to the command name.  This is the name\r
+                                     found on the command line in the shell.\r
+  @param[in, out] RetVal             The pointer to the return value from the command handler.\r
 \r
-  @param[in,out]  CanAffectLE       Indicates whether this command's return value\r
-                                    needs to be placed into LASTERROR environment variable.\r
+  @param[in, out]  CanAffectLE       Indicates whether this command's return value\r
+                                     needs to be placed into LASTERROR environment variable.\r
 \r
   @retval RETURN_SUCCESS            The handler was run.\r
   @retval RETURN_NOT_FOUND          The CommandString did not match a registered\r
index 2ee8ae5..5f3c558 100644 (file)
@@ -82,12 +82,12 @@ ShellSetFileInfo (
   This function opens a file with the open mode according to the file path. The\r
   Attributes is valid only for EFI_FILE_MODE_CREATE.\r
 \r
-  @param[in,out]  FilePath      On input, the device path to the file.  On output,\r
-                                the remaining device path.\r
-  @param[out]  DeviceHandle     Pointer to the system device handle.\r
-  @param[out]  FileHandle       Pointer to the file handle.\r
-  @param[in]  OpenMode          The mode to open the file with.\r
-  @param[in]  Attributes        The file's file attributes.\r
+  @param[in, out]  FilePath      On input, the device path to the file.  On output,\r
+                                 the remaining device path.\r
+  @param[out]   DeviceHandle     Pointer to the system device handle.\r
+  @param[out]   FileHandle       Pointer to the file handle.\r
+  @param[in]    OpenMode         The mode to open the file with.\r
+  @param[in]    Attributes       The file's file attributes.\r
 \r
   @retval EFI_SUCCESS          The information was set.\r
   @retval EFI_INVALID_PARAMETER        One of the parameters has an invalid value.\r
@@ -204,10 +204,10 @@ ShellCreateDirectory(
   are no more directory entries, the read returns a zero-length buffer.\r
   EFI_FILE_INFO is the structure returned as the directory entry.\r
 \r
-  @param[in] FileHandle         The opened file handle.\r
-  @param[in,out] ReadSize       On input the size of buffer in bytes.  On return\r
-                                the number of bytes written.\r
-  @param[out] Buffer            The buffer to put read data into.\r
+  @param[in] FileHandle          The opened file handle.\r
+  @param[in, out] ReadSize       On input the size of buffer in bytes.  On return\r
+                                 the number of bytes written.\r
+  @param[out] Buffer             The buffer to put read data into.\r
 \r
   @retval EFI_SUCCESS           Data was read.\r
   @retval EFI_NO_MEDIA         The device has no media.\r
@@ -235,12 +235,12 @@ ShellReadFile(
   The file is automatically grown to hold the data if required. Direct writes to\r
   opened directories are not supported.\r
 \r
-  @param[in] FileHandle         The opened file for writing.\r
+  @param[in] FileHandle          The opened file for writing.\r
 \r
-  @param[in,out] BufferSize     On input the number of bytes in Buffer.  On output\r
-                                the number of bytes written.\r
+  @param[in, out] BufferSize     On input the number of bytes in Buffer.  On output\r
+                                 the number of bytes written.\r
 \r
-  @param[in] Buffer             The buffer containing data to write is stored.\r
+  @param[in] Buffer              The buffer containing data to write is stored.\r
 \r
   @retval EFI_SUCCESS           Data was written.\r
   @retval EFI_UNSUPPORTED       Writes to an open directory are not supported.\r
@@ -402,9 +402,9 @@ ShellFindFirstFile (
   call of this function has no file to get. *NoFile will be set to TRUE, and the\r
   data in Buffer is meaningless.\r
 \r
-  @param[in] DirHandle          The file handle of the directory.\r
-  @param[in,out] Buffer         The pointer to buffer for file's information.\r
-  @param[in,out] NoFile         The pointer to boolean when last file is found.\r
+  @param[in] DirHandle           The file handle of the directory.\r
+  @param[in, out] Buffer         The pointer to buffer for file's information.\r
+  @param[in, out] NoFile         The pointer to boolean when last file is found.\r
 \r
   @retval EFI_SUCCESS           Found the next file.\r
   @retval EFI_NO_MEDIA          The device has no media.\r
@@ -583,9 +583,9 @@ ShellSetPageBreakMode (
   If you are NOT appending to an existing list *ListHead must be NULL.  If\r
   *ListHead is NULL then it must be callee freed.\r
 \r
-  @param[in] Arg                The pointer to path string.\r
-  @param[in] OpenMode           Mode to open files with.\r
-  @param[in,out] ListHead       Head of linked list of results.\r
+  @param[in] Arg                 The pointer to path string.\r
+  @param[in] OpenMode            Mode to open files with.\r
+  @param[in, out] ListHead       Head of linked list of results.\r
 \r
   @retval EFI_SUCCESS           The operation was sucessful and the list head\r
                                 contains the list of opened files.\r
@@ -604,7 +604,7 @@ ShellOpenFileMetaArg (
 /**\r
   Free the linked list returned from ShellOpenFileMetaArg.\r
 \r
-  @param[in,out] ListHead       The pointer to free.\r
+  @param[in, out] ListHead       The pointer to free.\r
 \r
   @retval EFI_SUCCESS           The operation was sucessful.\r
   @retval EFI_INVALID_PARAMETER A parameter was invalid.\r
@@ -1024,13 +1024,13 @@ ShellStrToUintn(
   If Destination's current length (including NULL terminator) is already more than\r
   CurrentSize, then ASSERT().\r
 \r
-  @param[in,out] Destination    The String to append onto.\r
-  @param[in,out] CurrentSize    On call, the number of bytes in Destination.  On\r
-                                return, possibly the new size (still in bytes).  If NULL,\r
-                                then allocate whatever is needed.\r
-  @param[in]     Source         The String to append from.\r
-  @param[in]     Count          The maximum number of characters to append.  If 0, then\r
-                                all are appended.\r
+  @param[in, out] Destination    The String to append onto.\r
+  @param[in, out] CurrentSize    On call, the number of bytes in Destination.  On\r
+                                 return, possibly the new size (still in bytes).  If NULL,\r
+                                 then allocate whatever is needed.\r
+  @param[in]      Source         The String to append from.\r
+  @param[in]      Count          The maximum number of characters to append.  If 0, then\r
+                                 all are appended.\r
 \r
   @return                       The Destination after appending the Source.\r
 **/\r
@@ -1051,14 +1051,14 @@ StrnCatGrow (
 \r
   If the string would grow bigger than NewSize it will halt and return error.\r
 \r
-  @param[in] SourceString             The string with source buffer.\r
-  @param[in,out] NewString            The string with resultant buffer.\r
-  @param[in] NewSize                  The size in bytes of NewString.\r
-  @param[in] FindTarget               The string to look for.\r
-  @param[in] ReplaceWith              The string to replace FindTarget with.\r
-  @param[in] SkipPreCarrot            If TRUE will skip a FindTarget that has a '^'\r
-                                      immediately before it.\r
-  @param[in] ParameterReplacing       If TRUE will add "" around items with spaces.\r
+  @param[in] SourceString              The string with source buffer.\r
+  @param[in, out] NewString            The string with resultant buffer.\r
+  @param[in] NewSize                   The size in bytes of NewString.\r
+  @param[in] FindTarget                The string to look for.\r
+  @param[in] ReplaceWith               The string to replace FindTarget with.\r
+  @param[in] SkipPreCarrot             If TRUE will skip a FindTarget that has a '^'\r
+                                       immediately before it.\r
+  @param[in] ParameterReplacing        If TRUE will add "" around items with spaces.\r
 \r
   @retval EFI_INVALID_PARAMETER       SourceString was NULL.\r
   @retval EFI_INVALID_PARAMETER       NewString was NULL.\r
@@ -1189,9 +1189,9 @@ ShellPromptForResponse (
 \r
   @param[in] Type What type of question is asked.  This is used to filter the input\r
                   to prevent invalid answers to question.\r
-  @param[in] HiiFormatStringId  The format string Id for getting from Hii.\r
-  @param[in] HiiFormatHandle    The format string Handle for getting from Hii.\r
-  @param[in,out] Response       The pointer to Response, which will be populated upon return.\r
+  @param[in] HiiFormatStringId   The format string Id for getting from Hii.\r
+  @param[in] HiiFormatHandle     The format string Handle for getting from Hii.\r
+  @param[in, out] Response       The pointer to Response, which will be populated upon return.\r
 \r
   @retval EFI_SUCCESS The operation was sucessful.\r
   @return other       The operation failed.\r
@@ -1273,11 +1273,11 @@ ShellFileExists(
   If the position upon start is 0, then the Ascii Boolean will be set.  This should be\r
   maintained and not changed for all operations with the same file.\r
 \r
-  @param[in]      Handle        SHELL_FILE_HANDLE to read from.\r
-  @param[in,out]  Ascii         Boolean value for indicating whether the file is\r
-                                Ascii (TRUE) or UCS2 (FALSE).\r
+  @param[in]       Handle        SHELL_FILE_HANDLE to read from.\r
+  @param[in, out]  Ascii         Boolean value for indicating whether the file is\r
+                                 Ascii (TRUE) or UCS2 (FALSE).\r
 \r
-  @return                       The line of text from the file.\r
+  @return                        The line of text from the file.\r
 \r
   @sa ShellFileHandleReadLine\r
 **/\r
@@ -1294,17 +1294,17 @@ ShellFileHandleReturnLine(
   If the position upon start is 0, then the Ascii Boolean will be set.  This should be\r
   maintained and not changed for all operations with the same file.\r
 \r
-  @param[in]      Handle        SHELL_FILE_HANDLE to read from.\r
-  @param[in,out]  Buffer        The pointer to buffer to read into.\r
-  @param[in,out]  Size          The pointer to number of bytes in Buffer.\r
-  @param[in]      Truncate      If the buffer is large enough, this has no effect.\r
-                                If the buffer is is too small and Truncate is TRUE,\r
-                                the line will be truncated.\r
-                                If the buffer is is too small and Truncate is FALSE,\r
-                                then no read will occur.\r
-\r
-  @param[in,out]  Ascii         Boolean value for indicating whether the file is\r
-                                Ascii (TRUE) or UCS2 (FALSE).\r
+  @param[in]       Handle        SHELL_FILE_HANDLE to read from.\r
+  @param[in, out]  Buffer        The pointer to buffer to read into.\r
+  @param[in, out]  Size          The pointer to number of bytes in Buffer.\r
+  @param[in]       Truncate      If the buffer is large enough, this has no effect.\r
+                                 If the buffer is is too small and Truncate is TRUE,\r
+                                 the line will be truncated.\r
+                                 If the buffer is is too small and Truncate is FALSE,\r
+                                 then no read will occur.\r
+\r
+  @param[in, out]  Ascii         Boolean value for indicating whether the file is\r
+                                 Ascii (TRUE) or UCS2 (FALSE).\r
 \r
   @retval EFI_SUCCESS           The operation was successful.  The line is stored in\r
                                 Buffer.\r
index 9d6be62..a3e0fd9 100644 (file)
@@ -43,12 +43,12 @@ INTN
   If Count is < 2 , then perform no action.\r
   If Size is < 1 , then perform no action.\r
 \r
-  @param[in,out] BufferToSort   On call, a Buffer of (possibly sorted) elements;\r
-                                on return, a buffer of sorted elements.\r
-  @param[in] Count              The number of elements in the buffer to sort.\r
-  @param[in] ElementSize        The size of an element in bytes.\r
-  @param[in] CompareFunction    The function to call to perform the comparison\r
-                                of any two elements.\r
+  @param[in, out] BufferToSort   On call, a Buffer of (possibly sorted) elements;\r
+                                 on return, a buffer of sorted elements.\r
+  @param[in]  Count              The number of elements in the buffer to sort.\r
+  @param[in]  ElementSize        The size of an element in bytes.\r
+  @param[in]  CompareFunction    The function to call to perform the comparison\r
+                                 of any two elements.\r
 **/\r
 VOID\r
 EFIAPI\r
index 64483c0..d36c1f6 100644 (file)
@@ -531,9 +531,9 @@ EFI_STATUS
   If there are multiple map names they will be semi-colon seperated in the\r
   NULL-terminated string.\r
 \r
-  @param[in,out] DevicePath     On entry, points to a device path pointer. On\r
-                                exit, updates the pointer to point to the\r
-                                portion of the device path after the mapping.\r
+  @param[in, out] DevicePath     On entry, points to a device path pointer. On\r
+                                 exit, updates the pointer to point to the\r
+                                 portion of the device path after the mapping.\r
 \r
   @retval NULL                  No mapping was found.\r
   @retval !=NULL                Pointer to NULL-terminated mapping. The buffer\r
@@ -640,10 +640,10 @@ EFI_STATUS
   according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each\r
   matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.\r
 \r
-  @param[in] Path               A pointer to the path string.\r
-  @param[in] OpenMode           Specifies the mode used to open each file, EFI_FILE_MODE_READ or\r
-                                EFI_FILE_MODE_WRITE.\r
-  @param[in,out] FileList       Points to the start of a list of files opened.\r
+  @param[in] Path                A pointer to the path string.\r
+  @param[in] OpenMode            Specifies the mode used to open each file, EFI_FILE_MODE_READ or\r
+                                 EFI_FILE_MODE_WRITE.\r
+  @param[in, out] FileList       Points to the start of a list of files opened.\r
 \r
   @retval EFI_SUCCESS           Create the file list successfully.\r
   @return                       Can't create the file list.\r
@@ -710,9 +710,9 @@ EFI_STATUS
   current position is increased by the number of bytes returned.\r
   If FileHandle is a directory, then an error is returned.\r
 \r
-  @param[in] FileHandle         The opened file handle for read.\r
-  @param[in] ReadSize           On input, the size of Buffer, in bytes. On output, the amount of data read.\r
-  @param[in,out] Buffer         The buffer in which data is read.\r
+  @param[in] FileHandle          The opened file handle for read.\r
+  @param[in] ReadSize            On input, the size of Buffer, in bytes. On output, the amount of data read.\r
+  @param[in, out] Buffer         The buffer in which data is read.\r
 \r
   @retval EFI_SUCCESS           Data was read.\r
   @retval EFI_NO_MEDIA          The device has no media.\r
@@ -929,9 +929,9 @@ EFI_STATUS
 \r
   Direct writes to opened directories are not supported.\r
 \r
-  @param[in] FileHandle             The opened file handle for writing.\r
-  @param[in,out] BufferSize         On input, size of Buffer.\r
-  @param[in] Buffer                 The buffer in which data to write.\r
+  @param[in] FileHandle              The opened file handle for writing.\r
+  @param[in, out] BufferSize         On input, size of Buffer.\r
+  @param[in] Buffer                  The buffer in which data to write.\r
 \r
   @retval EFI_SUCCESS               Data was written.\r
   @retval EFI_UNSUPPORTED           Writes to open directory are not supported.\r
index ad0b551..05ec69d 100644 (file)
@@ -61,7 +61,7 @@ EFI_STATUS
   This is used when programatically adding shell commands.  Upon successful return\r
   the memory allocated is up to the caller to free.\r
 \r
-  @param[in,out] Str              Pointer to pointer to string to display for help.\r
+  @param[in, out] Str              Pointer to pointer to string to display for help.\r
 \r
   @retval EFI_SUCCESS             The help string is in the parameter Str.\r
 \r
@@ -270,9 +270,9 @@ CHAR16*
   The memory allocated by the callee for this list is freed by making a call to\r
   SHELLENV_FREE_FILE_LIST.\r
 \r
-  @param[in] Arg                The pointer Path to files to open.\r
-  @param[in,out] ListHead       The pointer to the allocated and initialized list head\r
-                                upon which to append all opened file structures.\r
+  @param[in] Arg                 The pointer Path to files to open.\r
+  @param[in, out] ListHead       The pointer to the allocated and initialized list head\r
+                                 upon which to append all opened file structures.\r
 \r
   @retval EFI_SUCCESS           One or more files was opened and a struct of each file's\r
                                 information was appended to ListHead.\r
@@ -289,7 +289,7 @@ EFI_STATUS
 /**\r
   This frees all of the nodes under the ListHead, but not ListHead itself.\r
 \r
-  @param[in,out] ListHead       Pointer to list to free all nodes of.\r
+  @param[in, out] ListHead       Pointer to list to free all nodes of.\r
 \r
   @retval EFI_SUCCESS           This function always returns EFI_SUCCESS.\r
 **/\r
@@ -473,12 +473,12 @@ BOOLEAN
   This is an internal shell function to handle shell cascading.  It restores the\r
   original set of console protocols.\r
 \r
-  @param[in] ConInHandle        The handle of ConIn.\r
-  @param[in,out] ConIn          The pointer to the location to return the pointer to\r
-                                the original console input.\r
-  @param[in] ConOutHandle       The handle of ConOut\r
-  @param[in,out] ConOut         The pointer to the location to return the pointer to\r
-                                the original console output.\r
+  @param[in] ConInHandle         The handle of ConIn.\r
+  @param[in, out] ConIn          The pointer to the location to return the pointer to\r
+                                 the original console input.\r
+  @param[in] ConOutHandle        The handle of ConOut\r
+  @param[in, out] ConOut         The pointer to the location to return the pointer to\r
+                                 the original console output.\r
 **/\r
 typedef\r
 VOID\r
@@ -512,8 +512,8 @@ VOID
 \r
   This must be called after INIT_HANDLE_ENUMERATOR and before CLOSE_HANDLE_ENUMERATOR.\r
 \r
-  @param[in,out] Handle         The pointer to pointer to Handle.  It is set\r
-                                on a sucessful return.\r
+  @param[in, out] Handle         The pointer to pointer to Handle.  It is set\r
+                                 on a sucessful return.\r
 \r
   @retval EFI_SUCCESS           The next handle in the handle database is *Handle.\r
   @retval EFI_NOT_FOUND         There is not another handle.\r
@@ -656,7 +656,7 @@ VOID
   This cannot be called after CLOSE_PROTOCOL_INFO_ENUMERATOR, but it must be\r
   called after INIT_PROTOCOL_INFO_ENUMERATOR.\r
 \r
-  @param[in,out] ProtocolInfo   The pointer to pointer to protocol information structure.\r
+  @param[in, out] ProtocolInfo   The pointer to pointer to protocol information structure.\r
 \r
   @retval EFI_SUCCESS           The next protocol's information was sucessfully returned.\r
   @retval NULL                  There are no more protocols.\r
@@ -744,15 +744,15 @@ typedef struct {
 \r
   Upon successful return, the memory for *BestDeviceName is up to the caller to free.\r
 \r
-  @param[in] DeviceHandle           The device handle whose name is desired.\r
-  @param[in] UseComponentName       Whether to use the ComponentName protocol at all.\r
-  @param[in] UseDevicePath          Whether to use the DevicePath protocol at all.\r
-  @param[in] Language               The pointer to the language string to use.\r
-  @param[in,out] BestDeviceName     The pointer to pointer to string allocated with the name.\r
-  @param[out] ConfigurationStatus   The pointer to status for opening a Configuration protocol.\r
-  @param[out] DiagnosticsStatus     The pointer to status for opening a Diagnostics protocol.\r
-  @param[in] Display                Whether to Print this out to default Print location.\r
-  @param[in] Indent                 How many characters to indent the printing.\r
+  @param[in] DeviceHandle            The device handle whose name is desired.\r
+  @param[in] UseComponentName        Whether to use the ComponentName protocol at all.\r
+  @param[in] UseDevicePath           Whether to use the DevicePath protocol at all.\r
+  @param[in] Language                The pointer to the language string to use.\r
+  @param[in, out] BestDeviceName     The pointer to pointer to string allocated with the name.\r
+  @param[out] ConfigurationStatus    The pointer to status for opening a Configuration protocol.\r
+  @param[out] DiagnosticsStatus      The pointer to status for opening a Diagnostics protocol.\r
+  @param[in] Display                 Whether to Print this out to default Print location.\r
+  @param[in] Indent                  How many characters to indent the printing.\r
 \r
   @retval EFI_SUCCESS           This function always returns EFI_SUCCESS.\r
 **/\r
@@ -849,9 +849,9 @@ EFI_STATUS
   The memory allocated by the callee for this list is freed by making a call to\r
   SHELLENV_FREE_FILE_LIST.\r
 \r
-  @param[in] Arg                The pointer to the path of the files to be opened.\r
-  @param[in,out] ListHead       The pointer to allocated and initialized list head\r
-                                upon which to append all the opened file structures.\r
+  @param[in] Arg                 The pointer to the path of the files to be opened.\r
+  @param[in, out] ListHead       The pointer to allocated and initialized list head\r
+                                 upon which to append all the opened file structures.\r
 \r
   @retval EFI_SUCCESS           One or more files was opened and a struct of each file's\r
                                 information was appended to ListHead.\r
index b0d4bf3..77d5866 100644 (file)
@@ -20,7 +20,7 @@
   Removes the last directory or file entry in a path by changing the last\r
   L'\' to a CHAR_NULL.\r
 \r
-  @param[in,out] Path    The pointer to the path to modify.\r
+  @param[in, out] Path    The pointer to the path to modify.\r
 \r
   @retval FALSE     Nothing was found to remove.\r
   @retval TRUE      A directory or file was removed.\r
index 2a3058d..0b7e8f3 100644 (file)
   if Count is < 2 then perform no action.\r
   if Size is < 1 then perform no action.\r
 \r
-  @param[in,out] BufferToSort   on call a Buffer of (possibly sorted) elements\r
-                                on return a buffer of sorted elements\r
-  @param[in] Count              the number of elements in the buffer to sort\r
-  @param[in] ElementSize        Size of an element in bytes\r
-  @param[in] CompareFunction    The function to call to perform the comparison\r
-                                of any 2 elements\r
-  @param[in] Buffer             Buffer of size ElementSize for use in swapping\r
+  @param[in, out] BufferToSort   on call a Buffer of (possibly sorted) elements\r
+                                 on return a buffer of sorted elements\r
+  @param[in] Count               the number of elements in the buffer to sort\r
+  @param[in] ElementSize         Size of an element in bytes\r
+  @param[in] CompareFunction     The function to call to perform the comparison\r
+                                 of any 2 elements\r
+  @param[in] Buffer              Buffer of size ElementSize for use in swapping\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -139,12 +139,12 @@ QuickSortWorker (
   if Count is < 2 then perform no action.\r
   if Size is < 1 then perform no action.\r
 \r
-  @param[in,out] BufferToSort   on call a Buffer of (possibly sorted) elements\r
-                                on return a buffer of sorted elements\r
-  @param[in] Count              the number of elements in the buffer to sort\r
-  @param[in] ElementSize        Size of an element in bytes\r
-  @param[in] CompareFunction    The function to call to perform the comparison\r
-                                of any 2 elements\r
+  @param[in, out] BufferToSort   on call a Buffer of (possibly sorted) elements\r
+                                 on return a buffer of sorted elements\r
+  @param[in] Count               the number of elements in the buffer to sort\r
+  @param[in] ElementSize         Size of an element in bytes\r
+  @param[in] CompareFunction     The function to call to perform the comparison\r
+                                 of any 2 elements\r
 **/\r
 VOID\r
 EFIAPI\r
index fd8b7bb..a4820c9 100644 (file)
@@ -698,8 +698,8 @@ FileHandleSetSize (
   if Destination's current length (including NULL terminator) is already more then\r
   CurrentSize, then ASSERT()\r
 \r
-  @param[in,out] Destination   The String to append onto\r
-  @param[in,out] CurrentSize   on call the number of bytes in Destination.  On\r
+  @param[in, out] Destination   The String to append onto\r
+  @param[in, out] CurrentSize   on call the number of bytes in Destination.  On\r
                                 return possibly the new size (still in bytes).  if NULL\r
                                 then allocate whatever is needed.\r
   @param[in]      Source        The String to append from\r
@@ -879,8 +879,8 @@ FileHandleGetFileName (
   If the position upon start is 0, then the Ascii Boolean will be set.  This should be\r
   maintained and not changed for all operations with the same file.\r
 \r
-  @param[in]      Handle        FileHandle to read from.\r
-  @param[in,out]  Ascii         Boolean value for indicating whether the file is Ascii (TRUE) or UCS2 (FALSE);\r
+  @param[in]       Handle        FileHandle to read from.\r
+  @param[in, out]  Ascii         Boolean value for indicating whether the file is Ascii (TRUE) or UCS2 (FALSE);\r
 \r
   @return                       The line of text from the file.\r
 \r
@@ -919,13 +919,13 @@ FileHandleReturnLine(
   If the position upon start is 0, then the Ascii Boolean will be set.  This should be\r
   maintained and not changed for all operations with the same file.\r
 \r
-  @param[in]      Handle        FileHandle to read from\r
-  @param[in,out]  Buffer        pointer to buffer to read into\r
-  @param[in,out]  Size          pointer to number of bytes in buffer\r
-  @param[in]      Truncate      if TRUE then allows for truncation of the line to fit.\r
-                                if FALSE will reset the position to the begining of the\r
-                                line if the buffer is not large enough.\r
-  @param[in,out]  Ascii         Boolean value for indicating whether the file is Ascii (TRUE) or UCS2 (FALSE);\r
+  @param[in]       Handle        FileHandle to read from\r
+  @param[in, out]  Buffer        pointer to buffer to read into\r
+  @param[in, out]  Size          pointer to number of bytes in buffer\r
+  @param[in]       Truncate      if TRUE then allows for truncation of the line to fit.\r
+                                 if FALSE will reset the position to the begining of the\r
+                                 line if the buffer is not large enough.\r
+  @param[in, out]  Ascii         Boolean value for indicating whether the file is Ascii (TRUE) or UCS2 (FALSE);\r
 \r
   @retval EFI_SUCCESS           the operation was sucessful.  the line is stored in\r
                                 Buffer.\r
index eb1dbbd..131c077 100644 (file)
@@ -1179,10 +1179,10 @@ ParseHandleDatabaseForChildControllers(
 \r
   If DestinationBuffer is NULL, then ASSERT().\r
 \r
-  @param[in,out]  DestinationBuffer The pointer to the pointer to the buffer to append onto.\r
-  @param[in,out]  DestinationSize   The pointer to the size of DestinationBuffer.\r
-  @param[in]      SourceBuffer      The pointer to the buffer to append onto DestinationBuffer.\r
-  @param[in]      SourceSize        The number of bytes of SourceBuffer to append.\r
+  @param[in, out]  DestinationBuffer The pointer to the pointer to the buffer to append onto.\r
+  @param[in, out]  DestinationSize   The pointer to the size of DestinationBuffer.\r
+  @param[in]       SourceBuffer      The pointer to the buffer to append onto DestinationBuffer.\r
+  @param[in]       SourceSize        The number of bytes of SourceBuffer to append.\r
 \r
   @retval NULL                      A memory allocation failed.\r
   @retval NULL                      A parameter was invalid.\r
index fc9b906..9fbcbb3 100644 (file)
@@ -131,8 +131,8 @@ MTD_NAME  mMTDName[] = {
 /**\r
   Function to append a 64 bit number / 25 onto the string.\r
 \r
-  @param[in,out] Str          The string so append onto.\r
-  @param[in]     Num          The number to divide and append.\r
+  @param[in, out] Str          The string so append onto.\r
+  @param[in]      Num          The number to divide and append.\r
 \r
   @retval EFI_INVALID_PARAMETER   A parameter was NULL.\r
   @retval EFI_SUCCESS             The appending was successful.\r
@@ -163,8 +163,8 @@ AppendCSDNum2 (
 /**\r
   Function to append a 64 bit number onto the mapping info.\r
 \r
-  @param[in,out] MappingItem  The mapping info object to append onto.\r
-  @param[in]     Num          The info to append.\r
+  @param[in, out] MappingItem  The mapping info object to append onto.\r
+  @param[in]      Num          The info to append.\r
 \r
   @retval EFI_INVALID_PARAMETER   A parameter was NULL.\r
   @retval EFI_SUCCESS             The appending was successful.\r
@@ -194,8 +194,8 @@ AppendCSDNum (
 /**\r
   Function to append string into the mapping info.\r
 \r
-  @param[in,out] MappingItem  The mapping info object to append onto.\r
-  @param[in]     Str          The info to append.\r
+  @param[in, out] MappingItem  The mapping info object to append onto.\r
+  @param[in]      Str          The info to append.\r
 \r
   @retval EFI_INVALID_PARAMETER   A parameter was NULL.\r
   @retval EFI_SUCCESS             The appending was successful.\r
@@ -281,8 +281,8 @@ AppendCSDStr (
 /**\r
   Function to append a Guid to the mapping item.\r
 \r
-  @param[in,out] MappingItem  The item to append onto.\r
-  @param[in]     Guid         The guid to append.\r
+  @param[in, out] MappingItem  The item to append onto.\r
+  @param[in]      Guid         The guid to append.\r
 \r
   @retval EFI_SUCCESS           The appending operation was successful.\r
   @retval EFI_INVALID_PARAMETER A parameter was NULL.\r
index cb452d4..2c1dcd3 100644 (file)
@@ -424,12 +424,12 @@ ShellCommandGetProfileList (
   information will be returned. If Sections is NULL, then all help text information\r
   available will be returned.\r
 \r
-  @param[in]  CommandString         Pointer to the command name.  This is the name\r
-                                    found on the command line in the shell.\r
-  @param[in,out] RetVal             Pointer to the return vaule from the command handler.\r
+  @param[in]  CommandString          Pointer to the command name.  This is the name\r
+                                     found on the command line in the shell.\r
+  @param[in, out] RetVal             Pointer to the return vaule from the command handler.\r
 \r
-  @param[in,out]  CanAffectLE       indicates whether this command's return value\r
-                                    needs to be placed into LASTERROR environment variable.\r
+  @param[in, out]  CanAffectLE       indicates whether this command's return value\r
+                                     needs to be placed into LASTERROR environment variable.\r
 \r
   @retval RETURN_SUCCESS            The handler was run.\r
   @retval RETURN_NOT_FOUND          The CommandString did not match a registered\r
index 24926a8..de2ce2b 100644 (file)
@@ -49,8 +49,9 @@ typedef struct {
 \r
 /**\r
   This function will populate the device path protocol parameter based on TheHandle.\r
-  \r
-  @param[in,out] DevPath       On a sucessful return the device path to the handle.\r
+\r
+  @param[in]      TheHandle     Driver handle.\r
+  @param[in, out] FilePath      On a sucessful return the device path to the handle.\r
 \r
   @retval EFI_SUCCESS           The device path was sucessfully returned.\r
   @retval other                 A error from gBS->HandleProtocol.\r
index 01321d1..06a3210 100644 (file)
@@ -1324,10 +1324,10 @@ Encode (
 /**\r
   The compression routine.\r
 \r
-  @param[in]      SrcBuffer     The buffer containing the source data.\r
-  @param[in]      SrcSize       The number of bytes in SrcBuffer.\r
-  @param[in]      DstBuffer     The buffer to put the compressed image in.\r
-  @param[in,out]  DstSize       On input the size (in bytes) of DstBuffer, on\r
+  @param[in]       SrcBuffer     The buffer containing the source data.\r
+  @param[in]       SrcSize       The number of bytes in SrcBuffer.\r
+  @param[in]       DstBuffer     The buffer to put the compressed image in.\r
+  @param[in, out]  DstSize       On input the size (in bytes) of DstBuffer, on\r
                                 return the number of bytes placed in DstBuffer.\r
 \r
   @retval EFI_SUCCESS           The compression was sucessful.\r
index 64e339c..39a9971 100644 (file)
 /**\r
   The compression routine.\r
 \r
-  @param[in]      SrcBuffer     The buffer containing the source data.\r
-  @param[in]      SrcSize       Number of bytes in SrcBuffer.\r
-  @param[in]      DstBuffer     The buffer to put the compressed image in.\r
-  @param[in,out]  DstSize       On input the size (in bytes) of DstBuffer, on\r
-                                return the number of bytes placed in DstBuffer.\r
+  @param[in]       SrcBuffer     The buffer containing the source data.\r
+  @param[in]       SrcSize       Number of bytes in SrcBuffer.\r
+  @param[in]       DstBuffer     The buffer to put the compressed image in.\r
+  @param[in, out]  DstSize       On input the size (in bytes) of DstBuffer, on\r
+                                 return the number of bytes placed in DstBuffer.\r
 \r
   @retval EFI_SUCCESS           The compression was sucessful.\r
   @retval EFI_BUFFER_TOO_SMALL  The buffer was too small.  DstSize is required.\r
index ba62298..7d82884 100644 (file)
@@ -1685,8 +1685,8 @@ FileBufferScrollLeft (
 /**\r
   Delete a char in line\r
 \r
-  @param[in,out] Line   The line to delete in.\r
-  @param[in] Pos        Position to delete the char at ( start from 0 ).\r
+  @param[in, out] Line   The line to delete in.\r
+  @param[in] Pos         Position to delete the char at ( start from 0 ).\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -1710,8 +1710,8 @@ LineDeleteAt (
 /**\r
   Concatenate Src into Dest.\r
 \r
-  @param[in,out] Dest   Destination string\r
-  @param[in] Src        Src String.\r
+  @param[in, out] Dest   Destination string\r
+  @param[in] Src         Src String.\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -2981,7 +2981,7 @@ FileBufferSearch (
   //\r
   // found\r
   //\r
-  if (Found == TRUE) {\r
+  if (Found) {\r
     Column  = (Position - 1) + FileBuffer.FilePosition.Column + Offset;\r
     Row     = FileBuffer.FilePosition.Row;\r
   } else {\r
@@ -3000,7 +3000,7 @@ FileBufferSearch (
         Found   = TRUE;\r
       } \r
       \r
-      if (Found == TRUE) {\r
+      if (Found) {\r
         //\r
         // found\r
         //\r
index 3602a72..808f7a5 100644 (file)
@@ -106,10 +106,11 @@ HMainCommandDisplayHelp (
   VOID\r
   )\r
 {\r
-  INT32    CurrentLine=0;\r
+  INT32    CurrentLine;\r
   CHAR16 * InfoString;\r
   EFI_INPUT_KEY  Key;\r
-  \r
+\r
+  CurrentLine = 0;\r
   // print helpInfo      \r
   for (CurrentLine = 0; 0 != HexMainMenuHelpInfo[CurrentLine]; CurrentLine++) {\r
     InfoString = HiiGetString(gShellDebug1HiiHandle, HexMainMenuHelpInfo[CurrentLine]\r
index f327c5a..9d44abd 100644 (file)
@@ -41,11 +41,11 @@ HEFI_EDITOR_MEM_IMAGE             HMemImageConst = {
 /**\r
   Empty function.  always returns the same.\r
 \r
-  @param[in] This       Ignored.\r
-  @param[in] Width      Ignored.\r
-  @param[in] Address    Ignored.\r
-  @param[in] Count      Ignored.\r
-  @param[in,out] Buffer Ignored.\r
+  @param[in] This        Ignored.\r
+  @param[in] Width       Ignored.\r
+  @param[in] Address     Ignored.\r
+  @param[in] Count       Ignored.\r
+  @param[in, out] Buffer Ignored.\r
 \r
   @retval EFI_UNSUPPORTED.\r
 **/\r
@@ -65,11 +65,11 @@ DummyMemRead (
 /**\r
   Empty function.  always returns the same.\r
 \r
-  @param[in] This       Ignored.\r
-  @param[in] Width      Ignored.\r
-  @param[in] Address    Ignored.\r
-  @param[in] Count      Ignored.\r
-  @param[in,out] Buffer Ignored.\r
+  @param[in] This        Ignored.\r
+  @param[in] Width       Ignored.\r
+  @param[in] Address     Ignored.\r
+  @param[in] Count       Ignored.\r
+  @param[in, out] Buffer Ignored.\r
 \r
   @retval EFI_UNSUPPORTED.\r
 **/\r
index 3f4147f..e597bbc 100644 (file)
@@ -1268,7 +1268,7 @@ PCI_CLASS_ENTRY PCIPIFClass_0e00[] = {
                      bits 23:16 - Base Class Code\r
                      bits 15:8  - Sub-Class Code\r
                      bits  7:0  - Programming Interface\r
-  @param[in,out] ClassStrings   Pointer of PCI_CLASS_STRINGS structure, which contains\r
+  @param[in, out] ClassStrings   Pointer of PCI_CLASS_STRINGS structure, which contains\r
                  printable class strings corresponding to ClassCode. The\r
                  caller must not modify the strings that are pointed by\r
                  the fields in ClassStrings.\r
@@ -1474,11 +1474,11 @@ PciGetProtocolAndResource (
   It also moves the pointer backward a node, to get prepared to be called\r
   again.\r
 \r
-  @param[in,out] Descriptors Points to current position of a serial of address space\r
-                             descriptors.\r
-  @param[out] MinBus         The lower range of bus number.\r
-  @param[out] ManBus         The upper range of bus number.\r
-  @param[out] IsEnd          Meet end of the serial of descriptors.\r
+  @param[in, out] Descriptors Points to current position of a serial of address space\r
+                              descriptors.\r
+  @param[out] MinBus          The lower range of bus number.\r
+  @param[out] MaxBus          The upper range of bus number.\r
+  @param[out] IsEnd           Meet end of the serial of descriptors.\r
 \r
   @retval EFI_SUCCESS     The command completed successfully.\r
 **/\r
@@ -1543,11 +1543,11 @@ PciExplainBridgeData (
 /**\r
   Explain the Base Address Register(Bar) in PCI configuration space.\r
 \r
-  @param[in] Bar             Points to the Base Address Register intended to interpret.\r
-  @param[in] Command         Points to the register Command.\r
-  @param[in] Address         Address used to access configuration space of this PCI device.\r
-  @param[in] IoDev           Handle used to access configuration space of PCI device.\r
-  @param[in,out] Index       The Index.\r
+  @param[in] Bar              Points to the Base Address Register intended to interpret.\r
+  @param[in] Command          Points to the register Command.\r
+  @param[in] Address          Address used to access configuration space of this PCI device.\r
+  @param[in] IoDev            Handle used to access configuration space of PCI device.\r
+  @param[in, out] Index       The Index.\r
 \r
   @retval EFI_SUCCESS     The command completed successfully.\r
 **/\r
@@ -2564,11 +2564,11 @@ PciGetProtocolAndResource (
   It also moves the pointer backward a node, to get prepared to be called\r
   again.\r
 \r
-  @param[in,out] Descriptors Points to current position of a serial of address space\r
-                             descriptors.\r
-  @param[out] MinBus         The lower range of bus number.\r
-  @param[out] ManBus         The upper range of bus number.\r
-  @param[out] IsEnd          Meet end of the serial of descriptors.\r
+  @param[in, out] Descriptors Points to current position of a serial of address space\r
+                              descriptors.\r
+  @param[out] MinBus          The lower range of bus number.\r
+  @param[out] MaxBus          The upper range of bus number.\r
+  @param[out] IsEnd           Meet end of the serial of descriptors.\r
 \r
   @retval EFI_SUCCESS     The command completed successfully.\r
 **/\r
@@ -3148,11 +3148,11 @@ PciExplainBridgeData (
 /**\r
   Explain the Base Address Register(Bar) in PCI configuration space.\r
 \r
-  @param[in] Bar             Points to the Base Address Register intended to interpret.\r
-  @param[in] Command         Points to the register Command.\r
-  @param[in] Address         Address used to access configuration space of this PCI device.\r
-  @param[in] IoDev           Handle used to access configuration space of PCI device.\r
-  @param[in,out] Index       The Index.\r
+  @param[in] Bar              Points to the Base Address Register intended to interpret.\r
+  @param[in] Command          Points to the register Command.\r
+  @param[in] Address          Address used to access configuration space of this PCI device.\r
+  @param[in] IoDev            Handle used to access configuration space of PCI device.\r
+  @param[in, out] Index       The Index.\r
 \r
   @retval EFI_SUCCESS     The command completed successfully.\r
 **/\r
index 9e99568..ed73a58 100644 (file)
@@ -104,10 +104,10 @@ LibSmbiosGetEPS (
     Handle is changed to the next handle or 0xFFFF when the end is\r
     reached or the handle is not found.\r
 \r
-    @param[in,out] Handle     0xFFFF: get the first structure\r
-                              Others: get a structure according to this value.\r
-    @param[in,out] Buffer     The pointer to the caller's memory buffer.\r
-    @param[out] Length        Length of return buffer in bytes.\r
+    @param[in, out] Handle     0xFFFF: get the first structure\r
+                               Others: get a structure according to this value.\r
+    @param[in, out] Buffer     The pointer to the caller's memory buffer.\r
+    @param[out] Length         Length of return buffer in bytes.\r
 \r
     @retval DMI_SUCCESS   Buffer contains the required structure data\r
                           Handle is updated with next structure handle or\r
index 76442cd..5a9b2ad 100644 (file)
@@ -72,10 +72,10 @@ LibSmbiosGetEPS (
     Handle is changed to the next handle or 0xFFFF when the end is\r
     reached or the handle is not found.\r
 \r
-    @param[in,out] Handle     0xFFFF: get the first structure\r
-                              Others: get a structure according to this value.\r
-    @param[in,out] Buffer     The pointer to the caller's memory buffer.\r
-    @param[out] Length        Length of return buffer in bytes.\r
+    @param[in, out] Handle     0xFFFF: get the first structure\r
+                               Others: get a structure according to this value.\r
+    @param[in, out] Buffer     The pointer to the caller's memory buffer.\r
+    @param[out] Length         Length of return buffer in bytes.\r
 \r
     @retval DMI_SUCCESS   Buffer contains the required structure data\r
                           Handle is updated with next structure handle or\r
index 7a7caac..7c081bd 100644 (file)
@@ -82,9 +82,9 @@
   Copy Length of Src buffer to Dest buffer,\r
   add a NULL termination to Dest buffer.\r
 \r
-  @param[in,out] Dest  Destination buffer head.\r
-  @param[in] Src       Source buffer head.\r
-  @param[in] Length    Length of buffer to be copied.\r
+  @param[in, out] Dest  Destination buffer head.\r
+  @param[in] Src        Source buffer head.\r
+  @param[in] Length     Length of buffer to be copied.\r
 **/\r
 VOID\r
 MemToString (\r
index d84ab10..6499728 100644 (file)
@@ -2936,11 +2936,11 @@ TABLE_ITEM  StructureTypeInfoTable[] = {
     Then all the Key Value between Low and High gets the same string\r
     L"Unused".\r
 \r
-  @param[in] Table    The begin address of table.\r
-  @param[in] Number   The number of table items.\r
-  @param[in] Key      The query Key.\r
-  @param[in,out] Info Input as empty buffer; output as data buffer.\r
-  @param[in] InfoLen  The max number of characters for Info.\r
+  @param[in] Table     The begin address of table.\r
+  @param[in] Number    The number of table items.\r
+  @param[in] Key       The query Key.\r
+  @param[in, out] Info Input as empty buffer; output as data buffer.\r
+  @param[in] InfoLen   The max number of characters for Info.\r
 \r
   @return the found Key and Info is valid.\r
   @retval QUERY_TABLE_UNFOUND and Info should be NULL.\r
index 6809820..5a0c5e0 100644 (file)
@@ -52,11 +52,11 @@ typedef struct TABLE_ITEM {
     Then all the Key Value between Low and High gets the same string\r
     L"Unused".\r
 \r
-  @param[in] Table    The begin address of table.\r
-  @param[in] Number   The number of table items.\r
-  @param[in] Key      The query Key.\r
-  @param[in,out] Info Input as empty buffer; output as data buffer.\r
-  @param[in] InfoLen  The max number of characters for Info.\r
+  @param[in] Table     The begin address of table.\r
+  @param[in] Number    The number of table items.\r
+  @param[in] Key       The query Key.\r
+  @param[in, out] Info Input as empty buffer; output as data buffer.\r
+  @param[in] InfoLen   The max number of characters for Info.\r
 \r
   @return the found Key and Info is valid.\r
   @retval QUERY_TABLE_UNFOUND and Info should be NULL.\r
index f3cc8d9..b54d8e1 100644 (file)
@@ -226,8 +226,8 @@ CharToUpper (
   Function returns a system configuration table that is stored in the\r
   EFI System Table based on the provided GUID.\r
 \r
-  @param[in]  TableGuid    A pointer to the table's GUID type.\r
-  @param[in,out] Table     On exit, a pointer to a system configuration table.\r
+  @param[in]  TableGuid     A pointer to the table's GUID type.\r
+  @param[in, out] Table     On exit, a pointer to a system configuration table.\r
 \r
   @retval EFI_SUCCESS      A configuration table matching TableGuid was found.\r
   @retval EFI_NOT_FOUND    A configuration table matching TableGuid was not found.\r
@@ -281,8 +281,8 @@ HexCharToUintn (
 /**\r
   Convert a string representation of a guid to a Guid value.\r
 \r
-  @param[in] StringGuid   The pointer to the string of a guid.\r
-  @param[in,out] Guid     The pointer to the GUID structure to populate.\r
+  @param[in] StringGuid    The pointer to the string of a guid.\r
+  @param[in, out] Guid     The pointer to the GUID structure to populate.\r
 \r
   @retval EFI_INVALID_PARAMETER   A parameter was invalid.\r
   @retval EFI_SUCCESS             The conversion was successful.\r
index 3db03c8..7cabfe3 100644 (file)
@@ -82,8 +82,8 @@ DumpHex (
   Function returns a system configuration table that is stored in the\r
   EFI System Table based on the provided GUID.\r
 \r
-  @param[in]  TableGuid    A pointer to the table's GUID type.\r
-  @param[in,out] Table     On exit, a pointer to a system configuration table.\r
+  @param[in]   TableGuid    A pointer to the table's GUID type.\r
+  @param[in, out] Table     On exit, a pointer to a system configuration table.\r
 \r
   @retval EFI_SUCCESS      A configuration table matching TableGuid was found.\r
   @retval EFI_NOT_FOUND    A configuration table matching TableGuid was not found.\r
@@ -98,8 +98,8 @@ GetSystemConfigurationTable (
 /**\r
   Convert a string representation of a GUID to the GUID value.\r
 \r
-  @param[in] StringGuid   The pointer to the string containing a GUID printed.\r
-  @param[in,out] Guid     The pointer to the buffer to get the GUID value.\r
+  @param[in]  StringGuid   The pointer to the string containing a GUID printed.\r
+  @param[in, out] Guid     The pointer to the buffer to get the GUID value.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
index a6e27e9..7998bde 100644 (file)
 /**\r
   Get lots of info about a device from its handle.\r
 \r
-  @param[in] TheHandle      The device handle to get info on.\r
-  @param[in,out] Type       On successful return R, B, or D (root, bus, or \r
-                            device) will be placed in this buffer.\r
-  @param[in,out] Cfg        On successful return this buffer will be \r
-                            TRUE if the handle has configuration, FALSE\r
-                            otherwise.\r
-  @param[in,out] Diag       On successful return this buffer will be \r
-                            TRUE if the handle has disgnostics, FALSE\r
-                            otherwise.\r
-  @param[in,out] Parents    On successful return this buffer will be \r
-                            contain the number of parent handles.\r
-  @param[in,out] Devices    On successful return this buffer will be \r
-                            contain the number of devices controlled.\r
-  @param[in,out] Children   On successful return this buffer will be \r
-                            contain the number of child handles.\r
-  @param[out] Name          The pointer to a buffer that will be allocated\r
-                            and contain the string name of the handle.\r
-                            The caller must free this memory.\r
-  @param[in] Language       The language code as defined by the UEFI spec.\r
+  @param[in] TheHandle       The device handle to get info on.\r
+  @param[in, out] Type       On successful return R, B, or D (root, bus, or \r
+                             device) will be placed in this buffer.\r
+  @param[in, out] Cfg        On successful return this buffer will be \r
+                             TRUE if the handle has configuration, FALSE\r
+                             otherwise.\r
+  @param[in, out] Diag       On successful return this buffer will be \r
+                             TRUE if the handle has disgnostics, FALSE\r
+                             otherwise.\r
+  @param[in, out] Parents    On successful return this buffer will be \r
+                             contain the number of parent handles.\r
+  @param[in, out] Devices    On successful return this buffer will be \r
+                             contain the number of devices controlled.\r
+  @param[in, out] Children   On successful return this buffer will be \r
+                             contain the number of child handles.\r
+  @param[out] Name           The pointer to a buffer that will be allocated\r
+                             and contain the string name of the handle.\r
+                             The caller must free this memory.\r
+  @param[in] Language        The language code as defined by the UEFI spec.\r
 \r
   @retval EFI_SUCCESS           The info is there.\r
   @retval EFI_INVALID_PARAMETER A parameter was invalid.\r
index 78a4bd2..01f04a5 100644 (file)
@@ -49,8 +49,9 @@ typedef struct {
 \r
 /**\r
   This function will populate the device path protocol parameter based on TheHandle.\r
-  \r
-  @param[in,out] DevPath       On a sucessful return the device path to the handle.\r
+\r
+  @param[in]      TheHandle     Driver handle.\r
+  @param[in, out] FilePath      On a sucessful return the device path to the handle.\r
 \r
   @retval EFI_SUCCESS           The device path was sucessfully returned.\r
   @retval other                 A error from gBS->HandleProtocol.\r
index bc26ed3..4a85708 100644 (file)
@@ -120,9 +120,9 @@ typedef struct {
 /**\r
   Update the value of a given alias on the list.  If the alias is not there then add it.\r
 \r
-  @param[in] Alias              The alias to test for.\r
-  @param[in] CommandString      The updated command string.\r
-  @param[in,out] List           The list to search.\r
+  @param[in] Alias               The alias to test for.\r
+  @param[in] CommandString       The updated command string.\r
+  @param[in, out] List           The list to search.\r
 \r
   @retval EFI_SUCCESS           The operation was completed successfully.\r
   @retval EFI_OUT_OF_RESOURCES  There was not enough free memory.\r
@@ -216,8 +216,8 @@ InternalIsAliasOnList(
 /**\r
   Remove an alias from the given list.\r
 \r
-  @param[in] Alias              The alias to remove.\r
-  @param[in,out] List           The list to search.\r
+  @param[in] Alias               The alias to remove.\r
+  @param[in, out] List           The list to search.\r
 **/\r
 BOOLEAN\r
 EFIAPI\r
index b7f423f..d305306 100644 (file)
@@ -40,8 +40,8 @@ typedef enum {
 /**\r
   Extract the next fragment, if there is one.\r
 \r
-  @param[in,out] Statement    The current remaining statement.\r
-  @param[in] Fragment         The current fragment.\r
+  @param[in, out] Statement    The current remaining statement.\r
+  @param[in] Fragment          The current fragment.\r
 \r
   @retval FALSE   There is not another fragment.\r
   @retval TRUE    There is another fragment.\r
@@ -338,15 +338,15 @@ TestOperation (
 /**\r
   Process an if statement and determine if its is valid or not.\r
 \r
-  @param[in,out] PassingState     Opon entry, the current state.  Upon exit, \r
-                                  the new state.\r
-  @param[in] StartParameterNumber The number of the first parameter of\r
-                                  this statement.\r
-  @param[in] EndParameterNumber   The number of the final parameter of\r
-                                  this statement.\r
-  @param[in] OperatorToUse        The type of termination operator.\r
-  @param[in] CaseInsensitive      TRUE for case insensitive, FALSE otherwise.\r
-  @param[in] ForceStringCompare   TRUE for all string based, FALSE otherwise.\r
+  @param[in, out] PassingState     Opon entry, the current state.  Upon exit, \r
+                                   the new state.\r
+  @param[in] StartParameterNumber  The number of the first parameter of\r
+                                   this statement.\r
+  @param[in] EndParameterNumber    The number of the final parameter of\r
+                                   this statement.\r
+  @param[in] OperatorToUse         The type of termination operator.\r
+  @param[in] CaseInsensitive       TRUE for case insensitive, FALSE otherwise.\r
+  @param[in] ForceStringCompare    TRUE for all string based, FALSE otherwise.\r
 \r
   @retval EFI_INVALID_PARAMETER   A parameter was invalid.\r
   @retval EFI_SUCCESS             The operation was successful.                                  \r
index 72c5d07..7fc8690 100644 (file)
@@ -112,17 +112,17 @@ ShellLevel1CommandsLibDestructor (
 \r
   If label is used it will be used instead of the count.\r
 \r
-  @param[in] Function         The function to use to enumerate through the \r
-                              list.  Normally GetNextNode or GetPreviousNode.\r
-  @param[in] DecrementerTag   The tag to decrement the count at.\r
-  @param[in] IncrementerTag   The tag to increment the count at.\r
-  @param[in] Label            A label to look for.\r
-  @param[in,out] ScriptFile   The pointer to the current script file structure.\r
-  @param[in] MovePast         TRUE makes function return 1 past the found \r
-                              location.\r
-  @param[in] FindOnly         TRUE to not change the ScriptFile.\r
-  @param[in] CommandNode      The pointer to the Node to test.\r
-  @param[in,out] TargetCount  The pointer to the current count.\r
+  @param[in] Function          The function to use to enumerate through the \r
+                               list.  Normally GetNextNode or GetPreviousNode.\r
+  @param[in] DecrementerTag    The tag to decrement the count at.\r
+  @param[in] IncrementerTag    The tag to increment the count at.\r
+  @param[in] Label             A label to look for.\r
+  @param[in, out] ScriptFile   The pointer to the current script file structure.\r
+  @param[in] MovePast          TRUE makes function return 1 past the found \r
+                               location.\r
+  @param[in] FindOnly          TRUE to not change the ScriptFile.\r
+  @param[in] CommandNode       The pointer to the Node to test.\r
+  @param[in, out] TargetCount  The pointer to the current count.\r
 **/\r
 BOOLEAN\r
 EFIAPI\r
@@ -229,17 +229,17 @@ TestNodeForMove (
 \r
   If label is used it will be used instead of the count.\r
 \r
-  @param[in] Function         The function to use to enumerate through the \r
-                              list.  Normally GetNextNode or GetPreviousNode.\r
-  @param[in] DecrementerTag   The tag to decrement the count at.\r
-  @param[in] IncrementerTag   The tag to increment the count at.\r
-  @param[in] Label            A label to look for.\r
-  @param[in,out] ScriptFile   The pointer to the current script file structure.\r
-  @param[in] MovePast         TRUE makes function return 1 past the found \r
-                              location.\r
-  @param[in] FindOnly         TRUE to not change the ScriptFile.\r
-  @param[in] WrapAroundScript TRUE to wrap end-to-begining or vise versa in \r
-                              searching.\r
+  @param[in] Function          The function to use to enumerate through the \r
+                               list.  Normally GetNextNode or GetPreviousNode.\r
+  @param[in] DecrementerTag    The tag to decrement the count at.\r
+  @param[in] IncrementerTag    The tag to increment the count at.\r
+  @param[in] Label             A label to look for.\r
+  @param[in, out] ScriptFile   The pointer to the current script file structure.\r
+  @param[in] MovePast          TRUE makes function return 1 past the found \r
+                               location.\r
+  @param[in] FindOnly          TRUE to not change the ScriptFile.\r
+  @param[in] WrapAroundScript  TRUE to wrap end-to-begining or vise versa in \r
+                               searching.\r
 **/\r
 BOOLEAN\r
 EFIAPI\r
index 7b3efd2..e8439e7 100644 (file)
@@ -182,17 +182,17 @@ LIST_ENTRY *
 \r
   If label is used it will be used instead of the count.\r
 \r
-  @param[in] Function         The function to use to enumerate through the \r
-                              list.  Normally GetNextNode or GetPreviousNode.\r
-  @param[in] DecrementerTag   The tag to decrement the count at.\r
-  @param[in] IncrementerTag   The tag to increment the count at.\r
-  @param[in] Label            A label to look for.\r
-  @param[in,out] ScriptFile   The pointer to the current script file structure.\r
-  @param[in] MovePast         TRUE makes function return 1 past the found \r
-                              location.\r
-  @param[in] FindOnly         TRUE to not change the ScriptFile.\r
-  @param[in] WrapAroundScript TRUE to wrap end-to-begining or vise versa in \r
-                              searching.\r
+  @param[in] Function          The function to use to enumerate through the \r
+                               list.  Normally GetNextNode or GetPreviousNode.\r
+  @param[in] DecrementerTag    The tag to decrement the count at.\r
+  @param[in] IncrementerTag    The tag to increment the count at.\r
+  @param[in] Label             A label to look for.\r
+  @param[in, out] ScriptFile   The pointer to the current script file structure.\r
+  @param[in] MovePast          TRUE makes function return 1 past the found \r
+                               location.\r
+  @param[in] FindOnly          TRUE to not change the ScriptFile.\r
+  @param[in] WrapAroundScript  TRUE to wrap end-to-begining or vise versa in \r
+                               searching.\r
 **/\r
 BOOLEAN\r
 EFIAPI\r
index 5afcea2..b83eede 100644 (file)
@@ -116,9 +116,9 @@ IsValidMove(
 \r
   if the result is sucessful the caller must free *DestPathPointer.\r
 \r
-  @param[in] DestDir              The original path to the destination.\r
-  @param[in,out] DestPathPointer  A pointer to the callee allocated final path.\r
-  @param[in] Cwd                  A pointer to the current working directory.\r
+  @param[in] DestDir               The original path to the destination.\r
+  @param[in, out] DestPathPointer  A pointer to the callee allocated final path.\r
+  @param[in] Cwd                   A pointer to the current working directory.\r
 \r
   @retval EFI_INVALID_PARAMETR  The DestDir could not be resolved to a location.\r
   @retval EFI_INVALID_PARAMETR  The DestDir could be resolved to more than 1 location.\r
index e824895..598a2b4 100644 (file)
@@ -1313,8 +1313,8 @@ typedef struct {
   EFI_SHELL_FILE_INFO based list.  it is up to the caller to free the memory via\r
   the ShellCloseFileMetaArg function.\r
 \r
-  @param[in] FileList          the EFI shell list type\r
-  @param[in,out] ListHead      the list to add to\r
+  @param[in] FileList           the EFI shell list type\r
+  @param[in, out] ListHead      the list to add to\r
 \r
   @retval the resultant head of the double linked new format list;\r
 **/\r
@@ -2453,14 +2453,14 @@ ShellCommandLineCheckDuplicate (
 \r
   If the string would grow bigger than NewSize it will halt and return error.\r
 \r
-  @param[in] SourceString             The string with source buffer.\r
-  @param[in,out] NewString            The string with resultant buffer.\r
-  @param[in] NewSize                  The size in bytes of NewString.\r
-  @param[in] FindTarget               The string to look for.\r
-  @param[in] ReplaceWith              The string to replace FindTarget with.\r
-  @param[in] SkipPreCarrot            If TRUE will skip a FindTarget that has a '^'\r
-                                      immediately before it.\r
-  @param[in] ParameterReplacing       If TRUE will add "" around items with spaces.\r
+  @param[in] SourceString              The string with source buffer.\r
+  @param[in, out] NewString            The string with resultant buffer.\r
+  @param[in] NewSize                   The size in bytes of NewString.\r
+  @param[in] FindTarget                The string to look for.\r
+  @param[in] ReplaceWith               The string to replace FindTarget with.\r
+  @param[in] SkipPreCarrot             If TRUE will skip a FindTarget that has a '^'\r
+                                       immediately before it.\r
+  @param[in] ParameterReplacing        If TRUE will add "" around items with spaces.\r
 \r
   @retval EFI_INVALID_PARAMETER       SourceString was NULL.\r
   @retval EFI_INVALID_PARAMETER       NewString was NULL.\r
@@ -3020,8 +3020,8 @@ ShellStrToUintn(
   if Destination's current length (including NULL terminator) is already more then\r
   CurrentSize, then ASSERT()\r
 \r
-  @param[in,out] Destination   The String to append onto\r
-  @param[in,out] CurrentSize   on call the number of bytes in Destination.  On\r
+  @param[in, out] Destination   The String to append onto\r
+  @param[in, out] CurrentSize   on call the number of bytes in Destination.  On\r
                                 return possibly the new size (still in bytes).  if NULL\r
                                 then allocate whatever is needed.\r
   @param[in]      Source        The String to append from\r
@@ -3824,9 +3824,9 @@ ShellIsHexOrDecimalNumber (
   If the position upon start is 0, then the Ascii Boolean will be set.  This should be\r
   maintained and not changed for all operations with the same file.\r
 \r
-  @param[in]      Handle        SHELL_FILE_HANDLE to read from.\r
-  @param[in,out]  Ascii         Boolean value for indicating whether the file is\r
-                                Ascii (TRUE) or UCS2 (FALSE).\r
+  @param[in]       Handle        SHELL_FILE_HANDLE to read from.\r
+  @param[in, out]  Ascii         Boolean value for indicating whether the file is\r
+                                 Ascii (TRUE) or UCS2 (FALSE).\r
 \r
   @return                       The line of text from the file.\r
 \r
@@ -3865,17 +3865,17 @@ ShellFileHandleReturnLine(
   If the position upon start is 0, then the Ascii Boolean will be set.  This should be\r
   maintained and not changed for all operations with the same file.\r
 \r
-  @param[in]      Handle        SHELL_FILE_HANDLE to read from.\r
-  @param[in,out]  Buffer        The pointer to buffer to read into.\r
-  @param[in,out]  Size          The pointer to number of bytes in Buffer.\r
-  @param[in]      Truncate      If the buffer is large enough, this has no effect.\r
-                                If the buffer is is too small and Truncate is TRUE,\r
-                                the line will be truncated.\r
-                                If the buffer is is too small and Truncate is FALSE,\r
-                                then no read will occur.\r
-\r
-  @param[in,out]  Ascii         Boolean value for indicating whether the file is\r
-                                Ascii (TRUE) or UCS2 (FALSE).\r
+  @param[in]       Handle        SHELL_FILE_HANDLE to read from.\r
+  @param[in, out]  Buffer        The pointer to buffer to read into.\r
+  @param[in, out]  Size          The pointer to number of bytes in Buffer.\r
+  @param[in]       Truncate      If the buffer is large enough, this has no effect.\r
+                                 If the buffer is is too small and Truncate is TRUE,\r
+                                 the line will be truncated.\r
+                                 If the buffer is is too small and Truncate is FALSE,\r
+                                 then no read will occur.\r
+\r
+  @param[in, out]  Ascii         Boolean value for indicating whether the file is\r
+                                 Ascii (TRUE) or UCS2 (FALSE).\r
 \r
   @retval EFI_SUCCESS           The operation was successful.  The line is stored in\r
                                 Buffer.\r
index 13d2496..b4c4233 100644 (file)
@@ -249,10 +249,10 @@ GetChildHandle (
 /**\r
   Append OFFSET/WIDTH/VALUE items at the beginning of string.\r
 \r
-  @param[in,out]  String      The pointer to the string to append onto.\r
-  @param[in]      Offset      Offset value.\r
-  @param[in]      Width       Width value.\r
-  @param[in]      Block       Point to data buffer.\r
+  @param[in, out]  String      The pointer to the string to append onto.\r
+  @param[in]       Offset      Offset value.\r
+  @param[in]       Width       Width value.\r
+  @param[in]       Block       Point to data buffer.\r
 \r
   @return The count of unicode character that were appended.\r
 **/\r
index 4b89358..73ee783 100644 (file)
@@ -43,13 +43,13 @@ STATIC EFI_UNICODE_COLLATION_PROTOCOL   *mUnicodeCollation = NULL;
   if Count is < 2 then perform no action.\r
   if Size is < 1 then perform no action.\r
 \r
-  @param[in,out] BufferToSort   on call a Buffer of (possibly sorted) elements\r
-                                on return a buffer of sorted elements\r
-  @param[in] Count              the number of elements in the buffer to sort\r
-  @param[in] ElementSize        Size of an element in bytes\r
-  @param[in] CompareFunction    The function to call to perform the comparison\r
-                                of any 2 elements\r
-  @param[in] Buffer             Buffer of size ElementSize for use in swapping\r
+  @param[in, out] BufferToSort   on call a Buffer of (possibly sorted) elements\r
+                                 on return a buffer of sorted elements\r
+  @param[in] Count               the number of elements in the buffer to sort\r
+  @param[in] ElementSize         Size of an element in bytes\r
+  @param[in] CompareFunction     The function to call to perform the comparison\r
+                                 of any 2 elements\r
+  @param[in] Buffer              Buffer of size ElementSize for use in swapping\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -149,12 +149,12 @@ QuickSortWorker (
   if Count is < 2 then perform no action.\r
   if Size is < 1 then perform no action.\r
 \r
-  @param[in,out] BufferToSort   on call a Buffer of (possibly sorted) elements\r
-                                on return a buffer of sorted elements\r
-  @param[in] Count              the number of elements in the buffer to sort\r
-  @param[in] ElementSize        Size of an element in bytes\r
-  @param[in] CompareFunction    The function to call to perform the comparison\r
-                                of any 2 elements\r
+  @param[in, out] BufferToSort   on call a Buffer of (possibly sorted) elements\r
+                                 on return a buffer of sorted elements\r
+  @param[in] Count               the number of elements in the buffer to sort\r
+  @param[in] ElementSize         Size of an element in bytes\r
+  @param[in] CompareFunction     The function to call to perform the comparison\r
+                                 of any 2 elements\r
 **/\r
 VOID\r
 EFIAPI\r