Refine comments and two code style.

Signed-off-by: ydong10
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@12263 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/ShellPkg/Application/Shell/ConsoleLogger.h b/ShellPkg/Application/Shell/ConsoleLogger.h
index f7c5f6a7a28e223951cc310f1e4fd664d240fd11..c470cdb7abfd249bed85081033deb98e038c3cd9 100644 (file)
--- a/ShellPkg/Application/Shell/ConsoleLogger.h
+++ b/ShellPkg/Application/Shell/ConsoleLogger.h
@@ -80,7 +80,7 @@ ConsoleLoggerInstall(
   Return the system to the state it was before InstallConsoleLogger
   was installed.
 
   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.
 
   @retval EFI_SUCCESS     The operation was successful
   @return other           The operation failed.  This was from UninstallProtocolInterface.

diff --git a/ShellPkg/Application/Shell/ConsoleWrappers.c b/ShellPkg/Application/Shell/ConsoleWrappers.c
index 3212af9a08ce5b6264851396bb036ddf289b8ba8..561a666473dbcd8cf80dc93b9db0f64a4198febf 100644 (file)
--- a/ShellPkg/Application/Shell/ConsoleWrappers.c
+++ b/ShellPkg/Application/Shell/ConsoleWrappers.c
@@ -81,8 +81,8 @@ FileBasedSimpleTextInReset(
 /**\r
   ReadKeyStroke function for the fake simple text input.\r
 \r
 /**\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
 \r
   @retval   EFI_SUCCESS The read was successful.\r
 **/\r

diff --git a/ShellPkg/Application/Shell/FileHandleInternal.h b/ShellPkg/Application/Shell/FileHandleInternal.h
index ec55a6e4eb675c4b66faf22e8ddfc5c2da65da93..2aaae34214794064baf3b435d656d6e299f06b05 100644 (file)
--- a/ShellPkg/Application/Shell/FileHandleInternal.h
+++ b/ShellPkg/Application/Shell/FileHandleInternal.h
@@ -19,8 +19,8 @@
   Move the cursor position one character backward.
 
   @param[in] LineLength       Length of a line. Get it by calling QueryMode
   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
 **/
 VOID
 EFIAPI


@@ -35,8 +35,8 @@ MoveCursorBackward (
 
   @param[in] LineLength       Length of a line.
   @param[in] TotalRow         Total row of a screen
 
   @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
 **/
 VOID
 EFIAPI

diff --git a/ShellPkg/Application/Shell/FileHandleWrappers.c b/ShellPkg/Application/Shell/FileHandleWrappers.c
index 22e8c71d12b25162a9b2f2e0f6e0279659bbaa69..2e1ce08ef3dfe53961ea98786ea779060d0cbd27 100644 (file)
--- a/ShellPkg/Application/Shell/FileHandleWrappers.c
+++ b/ShellPkg/Application/Shell/FileHandleWrappers.c
@@ -95,10 +95,10 @@ FileInterfaceNopSetPosition(
 /**\r
   File style interface for console (GetInfo).\r
   \r
 /**\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
   \r
   @retval EFI_UNSUPPORTED\r
 **/\r


@@ -141,9 +141,9 @@ FileInterfaceNopSetInfo(
 \r
   Writes data to the screen.\r
   \r
 \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
   \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
 /**\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
   \r
   @retval EFI_UNSUPPORTED\r
 **/\r


@@ -188,9 +188,9 @@ FileInterfaceStdInWrite(
 \r
   Writes error to the error output.\r
   \r
 \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
   \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
 /**\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
   \r
   @retval EFI_UNSUPPORTED\r
 **/\r


@@ -228,9 +228,9 @@ FileInterfaceStdOutRead(
 /**\r
   File style interface for console StdErr (Read).\r
   \r
 /**\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
   \r
   @retval EFI_UNSUPPORTED Always.\r
 **/\r


@@ -248,9 +248,9 @@ FileInterfaceStdErrRead(
 /**\r
   File style interface for NUL file (Read).\r
   \r
 /**\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
   \r
   @retval EFI_SUCCESS Always.\r
 **/\r


@@ -269,9 +269,9 @@ FileInterfaceNulRead(
 /**\r
   File style interface for NUL file (Write).\r
   \r
 /**\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
   \r
   @retval EFI_SUCCESS\r
 **/\r


@@ -974,9 +974,9 @@ FileInterfaceEnvDelete(
 /**\r
   File style interface for Environment Variable (Read).\r
   \r
 /**\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
   \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
 /**\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
   \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
 /**\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
   \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
   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
 **/\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
 \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
 **/\r
 VOID\r
 EFIAPI\r


@@ -1323,9 +1323,9 @@ FileInterfaceMemGetPosition(
 /**\r
   File style interface for Mem (Write).\r
   \r
 /**\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
   \r
   @retval EFI_SUCCESS   The data was written.\r
 **/\r


@@ -1369,9 +1369,9 @@ FileInterfaceMemWrite(
 /**\r
   File style interface for Mem (Read).\r
   \r
 /**\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
   \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
   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
   \r
   @retval EFI_SUCCESS   The data was written.\r
 **/\r

diff --git a/ShellPkg/Application/Shell/Shell.c b/ShellPkg/Application/Shell/Shell.c
index e817a1114267b7ec7e84f9e8ecc33f0aae8f090e..3a5899f342ee989f9683e731e96f11a931078ea9 100644 (file)
--- a/ShellPkg/Application/Shell/Shell.c
+++ b/ShellPkg/Application/Shell/Shell.c
@@ -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
   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
 \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
   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
 \r
   @retval EFI_SUCCESS             The name was changed.\r
   @retval EFI_SUCCESS             The name was not an alias.\r

diff --git a/ShellPkg/Application/Shell/Shell.h b/ShellPkg/Application/Shell/Shell.h
index e79c5481f376ae306e550952a47df5b56d82d068..d01b1260750e86f10babc7c4cfec2ef6b59d8a82 100644 (file)
--- a/ShellPkg/Application/Shell/Shell.h
+++ b/ShellPkg/Application/Shell/Shell.h
@@ -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
   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
 \r
   @retval EFI_SUCCESS           the 2 device paths were sucessfully returned.\r
   @return other                 a error from gBS->HandleProtocol\r

diff --git a/ShellPkg/Application/Shell/ShellEnvVar.c b/ShellPkg/Application/Shell/ShellEnvVar.c
index d674f14c24c30c8050b875bc4b59d6216217ebf2..a4bd6a61797c5a9bee45035be2af3d44ea01bcb0 100644 (file)
--- a/ShellPkg/Application/Shell/ShellEnvVar.c
+++ b/ShellPkg/Application/Shell/ShellEnvVar.c
@@ -123,8 +123,8 @@ FreeEnvironmentVariableList(
 /**\r
   Creates a list of all Shell-Guid-based environment variables.\r
 \r
 /**\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
 \r
   @retval EFI_SUCCESS           the list was created sucessfully.\r
 **/\r

diff --git a/ShellPkg/Application/Shell/ShellEnvVar.h b/ShellPkg/Application/Shell/ShellEnvVar.h
index 277895994aa500c9d63c3b429f4aa2dc8e367e1e..ab3d9166db4cdde8958fa670a0e32ffe887994e9 100644 (file)
--- a/ShellPkg/Application/Shell/ShellEnvVar.h
+++ b/ShellPkg/Application/Shell/ShellEnvVar.h
@@ -145,8 +145,8 @@ IsVolatileEnv (
 /**\r
   Creates a list of all Shell-Guid-based environment variables.\r
 \r
 /**\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
 \r
   @retval EFI_SUCCESS           the list was created sucessfully.\r
 **/\r

diff --git a/ShellPkg/Application/Shell/ShellManParser.c b/ShellPkg/Application/Shell/ShellManParser.c
index ab32c36b7502816a31db79b2da770366f434a60d..bcc1f8e0a3b463fa65225e0dda70a7b3551d5c8e 100644 (file)
--- a/ShellPkg/Application/Shell/ShellManParser.c
+++ b/ShellPkg/Application/Shell/ShellManParser.c
@@ -423,12 +423,12 @@ ManBufferFindTitleSection(
 \r
   Upon a sucessful return the caller is responsible to free the memory in *BriefDesc\r
 \r
 \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
 \r
   @retval EFI_OUT_OF_RESOURCES  a memory allocation failed.\r
   @retval EFI_SUCCESS           the section was found and its description sotred in\r

diff --git a/ShellPkg/Application/Shell/ShellParametersProtocol.c b/ShellPkg/Application/Shell/ShellParametersProtocol.c
index 99a7294842894f423208d2308de613bb9c704126..02606d615bedf86fb9947640e96b6a7881d31136 100644 (file)
--- a/ShellPkg/Application/Shell/ShellParametersProtocol.c
+++ b/ShellPkg/Application/Shell/ShellParametersProtocol.c
@@ -26,9 +26,9 @@
   Temp Parameter must be large enough to hold the parameter before calling this\r
   function.\r
 \r
   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
                                 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
 \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
   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
 \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
   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
                                      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
                                      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
 \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
 **/\r
 VOID\r
 EFIAPI\r


@@ -477,12 +477,12 @@ StripQuotes (
 \r
   This will also update the system table.\r
 \r
 \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
 \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
   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
 **/\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
 \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
 \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
   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
 **/\r
 VOID\r
 EFIAPI\r

diff --git a/ShellPkg/Application/Shell/ShellParametersProtocol.h b/ShellPkg/Application/Shell/ShellParametersProtocol.h
index df3bfa7cbcc2bd8982d35e55eda532ea88c6f927..b63e1d394f9fdd8dfb9956c98ad357211ce6b80a 100644 (file)
--- a/ShellPkg/Application/Shell/ShellParametersProtocol.h
+++ b/ShellPkg/Application/Shell/ShellParametersProtocol.h
@@ -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
   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
                                      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
                                      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
   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
   @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
   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
 **/\r
 VOID\r
 EFIAPI\r


@@ -134,12 +134,12 @@ typedef struct {
 \r
   This will also update the system table.\r
 \r
 \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
 \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
   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
 **/\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
   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
 \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
   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
                                 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
 \r
 **/\r
 VOID\r

diff --git a/ShellPkg/Application/Shell/ShellProtocol.c b/ShellPkg/Application/Shell/ShellProtocol.c
index e42f081834de528d600b67725854bd1716fb2299..ee40e40f0805332636ef45e2998deca1276df7aa 100644 (file)
--- a/ShellPkg/Application/Shell/ShellProtocol.c
+++ b/ShellPkg/Application/Shell/ShellProtocol.c
@@ -1945,8 +1945,8 @@ EfiShellFindFilesInDir(
 /**\r
   Updates a file name to be preceeded by the mapped drive name\r
 \r
 /**\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
 \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
   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
 \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
 \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
   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
   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
 \r
   @retval EFI_SUCCESS       The operation was successful.\r
 **/\r

diff --git a/ShellPkg/Application/Shell/ShellProtocol.h b/ShellPkg/Application/Shell/ShellProtocol.h
index 1b809ecd29e8e34010513e4d9b8a075057a0ff3b..a63ae8fc83c29eb072e858c85ce581925382e0c0 100644 (file)
--- a/ShellPkg/Application/Shell/ShellProtocol.h
+++ b/ShellPkg/Application/Shell/ShellProtocol.h
@@ -68,7 +68,7 @@ typedef struct {
 \r
   This must be removed via calling CleanUpShellProtocol().\r
 \r
 \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
   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
   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
 \r
   @retval EFI_SUCCESS       The operation was successful.\r
 **/\r

diff --git a/ShellPkg/Application/ShellSortTestApp/ShellSortTestApp.c b/ShellPkg/Application/ShellSortTestApp/ShellSortTestApp.c
index 91817ee291c9d209a898b637c0f1bbd4de1010d2..d1a056898a52eff9a72214145fbceeda946f5890 100644 (file)
--- a/ShellPkg/Application/ShellSortTestApp/ShellSortTestApp.c
+++ b/ShellPkg/Application/ShellSortTestApp/ShellSortTestApp.c
@@ -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
   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
 \r
   @retval  0               The application exited normally.\r
   @retval  Other           An error occurred.\r

diff --git a/ShellPkg/Include/Library/FileHandleLib.h b/ShellPkg/Include/Library/FileHandleLib.h
index b4c2e7ddee294f789d808365d6e115c60d73d429..a21e20ed95ef112c943c8a64f7c3ccc885cfaf03 100644 (file)
--- a/ShellPkg/Include/Library/FileHandleLib.h
+++ b/ShellPkg/Include/Library/FileHandleLib.h
@@ -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
   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
 \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
   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
 \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
   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
 \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
 \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
   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
 \r
   @return                       The line of text from the file.\r
 \r

diff --git a/ShellPkg/Include/Library/PathLib.h b/ShellPkg/Include/Library/PathLib.h
index 912b1f14b0c3b8ab775e0f801a14490f9a3c457f..ee473523d265e1b9c81629408bc7f68096f623f0 100644 (file)
--- a/ShellPkg/Include/Library/PathLib.h
+++ b/ShellPkg/Include/Library/PathLib.h
@@ -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
   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
 \r
   @retval FALSE     Nothing was found to remove.\r
   @retval TRUE      A directory or file was removed.\r

diff --git a/ShellPkg/Include/Library/ShellCommandLib.h b/ShellPkg/Include/Library/ShellCommandLib.h
index 5bc03ce256cc20f45526d95fa068f1621add7cb2..f453d22f3d8e12fdc39fa481f1bc9dbc8f50cf4b 100644 (file)
--- a/ShellPkg/Include/Library/ShellCommandLib.h
+++ b/ShellPkg/Include/Library/ShellCommandLib.h
@@ -159,12 +159,12 @@ ShellCommandRegisterCommandName (
   information is returned. If Sections is NULL, then all help text information\r
   available is returned.\r
 \r
   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
 \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
 \r
   @retval RETURN_SUCCESS            The handler was run.\r
   @retval RETURN_NOT_FOUND          The CommandString did not match a registered\r

diff --git a/ShellPkg/Include/Library/ShellLib.h b/ShellPkg/Include/Library/ShellLib.h
index 2ee8ae5428d5634b68d51df8e38a6ec596151848..5f3c5588bba4b6122ed12e6263c98aaa9ad1749e 100644 (file)
--- a/ShellPkg/Include/Library/ShellLib.h
+++ b/ShellPkg/Include/Library/ShellLib.h
@@ -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
   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
 \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
   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
 \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
   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
 \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
 \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
 \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
   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
 \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
   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
 \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
 /**\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
 \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
   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
 \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
 \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
 \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
 \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
 \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
   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
 \r

-  @return                       The line of text from the file.\r
+  @return                        The line of text from the file.\r

 \r
   @sa ShellFileHandleReadLine\r
 **/\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
   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
 \r
   @retval EFI_SUCCESS           The operation was successful.  The line is stored in\r
                                 Buffer.\r

diff --git a/ShellPkg/Include/Library/SortLib.h b/ShellPkg/Include/Library/SortLib.h
index 9d6be6283b36012bd61680129318090beb75e7a7..a3e0fd9bec877f10eb09c0c5169936561d06850c 100644 (file)
--- a/ShellPkg/Include/Library/SortLib.h
+++ b/ShellPkg/Include/Library/SortLib.h
@@ -43,12 +43,12 @@ INTN
   If Count is < 2 , then perform no action.\r
   If Size is < 1 , then perform no action.\r
 \r
   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
 **/\r
 VOID\r
 EFIAPI\r

diff --git a/ShellPkg/Include/Protocol/EfiShell.h b/ShellPkg/Include/Protocol/EfiShell.h
index 64483c01c2a7bf1e867948f31c2703050b18fca8..d36c1f6b17da2347c834bb1b53663e7d491e868b 100644 (file)
--- a/ShellPkg/Include/Protocol/EfiShell.h
+++ b/ShellPkg/Include/Protocol/EfiShell.h
@@ -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
   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
 \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
   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
 \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
   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
 \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
 \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
 \r
   @retval EFI_SUCCESS               Data was written.\r
   @retval EFI_UNSUPPORTED           Writes to open directory are not supported.\r

diff --git a/ShellPkg/Include/Protocol/EfiShellEnvironment2.h b/ShellPkg/Include/Protocol/EfiShellEnvironment2.h
index ad0b551b96ea6b55cfe7030a7a651cdbf77aebcd..05ec69d5ac02e0ab6f9e6e9c21860c3fec711c8f 100644 (file)
--- a/ShellPkg/Include/Protocol/EfiShellEnvironment2.h
+++ b/ShellPkg/Include/Protocol/EfiShellEnvironment2.h
@@ -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
   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
 \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
   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
 \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
 /**\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
 \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
   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
 **/\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
 \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
 \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
   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
 \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
 \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
 \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
   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
 \r
   @retval EFI_SUCCESS           One or more files was opened and a struct of each file's\r
                                 information was appended to ListHead.\r

diff --git a/ShellPkg/Library/BasePathLib/BasePathLib.c b/ShellPkg/Library/BasePathLib/BasePathLib.c
index b0d4bf34c2099fbc46b62ffdb424fb3c735ad30d..77d5866a817af43a5b144c76759d9b230bb7ccef 100644 (file)
--- a/ShellPkg/Library/BasePathLib/BasePathLib.c
+++ b/ShellPkg/Library/BasePathLib/BasePathLib.c
@@ -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
   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
 \r
   @retval FALSE     Nothing was found to remove.\r
   @retval TRUE      A directory or file was removed.\r

diff --git a/ShellPkg/Library/BaseSortLib/BaseSortLib.c b/ShellPkg/Library/BaseSortLib/BaseSortLib.c
index 2a3058d3caeb7a35494d9a2229463e615066cd3c..0b7e8f3f6f1c72c178e433b61fd34b29cc5550a1 100644 (file)
--- a/ShellPkg/Library/BaseSortLib/BaseSortLib.c
+++ b/ShellPkg/Library/BaseSortLib/BaseSortLib.c
@@ -34,13 +34,13 @@
   if Count is < 2 then perform no action.\r
   if Size is < 1 then perform no action.\r
 \r
   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
 **/\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
   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
 **/\r
 VOID\r
 EFIAPI\r

diff --git a/ShellPkg/Library/UefiFileHandleLib/UefiFileHandleLib.c b/ShellPkg/Library/UefiFileHandleLib/UefiFileHandleLib.c
index fd8b7bbaec1d14bd4b25ae60c084dc901b0a0d37..a4820c9970e6db7f8c95db0d3700a1b0c9f2a424 100644 (file)
--- a/ShellPkg/Library/UefiFileHandleLib/UefiFileHandleLib.c
+++ b/ShellPkg/Library/UefiFileHandleLib/UefiFileHandleLib.c
@@ -698,8 +698,8 @@ FileHandleSetSize (
   if Destination's current length (including NULL terminator) is already more then\r
   CurrentSize, then ASSERT()\r
 \r
   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
                                 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
   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
 \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
   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
 \r
   @retval EFI_SUCCESS           the operation was sucessful.  the line is stored in\r
                                 Buffer.\r

diff --git a/ShellPkg/Library/UefiHandleParsingLib/UefiHandleParsingLib.c b/ShellPkg/Library/UefiHandleParsingLib/UefiHandleParsingLib.c
index eb1dbbd3fd5b284f0c46b3608a0db6abd1450460..131c077b1e2b2628e322077f4bf75d87d0336533 100644 (file)
--- a/ShellPkg/Library/UefiHandleParsingLib/UefiHandleParsingLib.c
+++ b/ShellPkg/Library/UefiHandleParsingLib/UefiHandleParsingLib.c
@@ -1179,10 +1179,10 @@ ParseHandleDatabaseForChildControllers(
 \r
   If DestinationBuffer is NULL, then ASSERT().\r
 \r
 \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
 \r
   @retval NULL                      A memory allocation failed.\r
   @retval NULL                      A parameter was invalid.\r

diff --git a/ShellPkg/Library/UefiShellCommandLib/ConsistMapping.c b/ShellPkg/Library/UefiShellCommandLib/ConsistMapping.c
index fc9b906ffdd53d9e1c5d1bb7e3a3a5a50f416d49..9fbcbb3eb2621f65333bb5a90963d0ff4c59e00a 100644 (file)
--- a/ShellPkg/Library/UefiShellCommandLib/ConsistMapping.c
+++ b/ShellPkg/Library/UefiShellCommandLib/ConsistMapping.c
@@ -131,8 +131,8 @@ MTD_NAME  mMTDName[] = {
 /**\r
   Function to append a 64 bit number / 25 onto the string.\r
 \r
 /**\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
 \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
 /**\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
 \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
 /**\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
 \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
 /**\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
 \r
   @retval EFI_SUCCESS           The appending operation was successful.\r
   @retval EFI_INVALID_PARAMETER A parameter was NULL.\r

diff --git a/ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.c b/ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.c
index cb452d44d5bce6ed67e5253d16ddd7c4d8b8082f..2c1dcd3c1308f59a43a69ff576611e4dcdc90daf 100644 (file)
--- a/ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.c
+++ b/ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.c
@@ -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
   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
 \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
 \r
   @retval RETURN_SUCCESS            The handler was run.\r
   @retval RETURN_NOT_FOUND          The CommandString did not match a registered\r

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/Bcfg.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/Bcfg.c
index 24926a8e9a9578f5357870fc8f482891daf9f651..de2ce2bfc3c28f8571d3cae7a164f7ac6a0e4687 100644 (file)
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/Bcfg.c
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/Bcfg.c
@@ -49,8 +49,9 @@ typedef struct {
 \r
 /**\r
   This function will populate the device path protocol parameter based on TheHandle.\r
 \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
 \r
   @retval EFI_SUCCESS           The device path was sucessfully returned.\r
   @retval other                 A error from gBS->HandleProtocol.\r

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.c
index 01321d1ed674d7451750afb0c0e1d3ceccc49085..06a3210ea09a72b97dd349338539ce1d1e81cc9d 100644 (file)
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.c
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.c
@@ -1324,10 +1324,10 @@ Encode (
 /**\r
   The compression routine.\r
 \r
 /**\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
                                 return the number of bytes placed in DstBuffer.\r
 \r
   @retval EFI_SUCCESS           The compression was sucessful.\r

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.h b/ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.h
index 64e339cf973a0000d2b0f2e7011ccfaa5d246ded..39a997178fb78526231bd035e7c50b6932f9e730 100644 (file)
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.h
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.h
@@ -18,11 +18,11 @@
 /**\r
   The compression routine.\r
 \r
 /**\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
 \r
   @retval EFI_SUCCESS           The compression was sucessful.\r
   @retval EFI_BUFFER_TOO_SMALL  The buffer was too small.  DstSize is required.\r

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/Edit/FileBuffer.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/Edit/FileBuffer.c
index ba622983e1a19ccc066da1b7ca961a98d6e44bef..7d8288432608ef8b158af815fe559aff86a1c63b 100644 (file)
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/Edit/FileBuffer.c
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/Edit/FileBuffer.c
@@ -1685,8 +1685,8 @@ FileBufferScrollLeft (
 /**\r
   Delete a char in line\r
 \r
 /**\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
 **/\r
 VOID\r
 EFIAPI\r


@@ -1710,8 +1710,8 @@ LineDeleteAt (
 /**\r
   Concatenate Src into Dest.\r
 \r
 /**\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
 **/\r
 VOID\r
 EFIAPI\r


@@ -2981,7 +2981,7 @@ FileBufferSearch (
   //\r
   // found\r
   //\r
   //\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
     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
         Found   = TRUE;\r
       } \r
       \r

-      if (Found == TRUE) {\r
+      if (Found) {\r

         //\r
         // found\r
         //\r
         //\r
         // found\r
         //\r

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MainHexEditor.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MainHexEditor.c
index 3602a72433146d4a0246f8b4e691c4192bac567c..808f7a56c0ca9d89a891e862ce120251256ea703 100644 (file)
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MainHexEditor.c
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MainHexEditor.c
@@ -106,10 +106,11 @@ HMainCommandDisplayHelp (
   VOID\r
   )\r
 {\r
   VOID\r
   )\r
 {\r

-  INT32    CurrentLine=0;\r
+  INT32    CurrentLine;\r

   CHAR16 * InfoString;\r
   EFI_INPUT_KEY  Key;\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
   // print helpInfo      \r
   for (CurrentLine = 0; 0 != HexMainMenuHelpInfo[CurrentLine]; CurrentLine++) {\r
     InfoString = HiiGetString(gShellDebug1HiiHandle, HexMainMenuHelpInfo[CurrentLine]\r

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MemImage.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MemImage.c
index f327c5aedeed60281f9b754b65c9e9eef8e12612..9d44abddd7fe59e4d9e66798f23647604fcd16b9 100644 (file)
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MemImage.c
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MemImage.c
@@ -41,11 +41,11 @@ HEFI_EDITOR_MEM_IMAGE             HMemImageConst = {
 /**\r
   Empty function.  always returns the same.\r
 \r
 /**\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
 \r
   @retval EFI_UNSUPPORTED.\r
 **/\r


@@ -65,11 +65,11 @@ DummyMemRead (
 /**\r
   Empty function.  always returns the same.\r
 \r
 /**\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
 \r
   @retval EFI_UNSUPPORTED.\r
 **/\r

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/Pci.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/Pci.c
index 3f4147f9a115dce0a3f4238636208d3a55c96409..e597bbc6b052d232aefa522f878f79730a1e75af 100644 (file)
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/Pci.c
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/Pci.c
@@ -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
                      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
                  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
   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
 \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
 /**\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
 \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
   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
 \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
 /**\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
 \r
   @retval EFI_SUCCESS     The command completed successfully.\r
 **/\r

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.c
index 9e995683d0e6f2505c708bc1403a36a7ce6dca9e..ed73a584bd533025b63c1a398a130d2a5f207fb0 100644 (file)
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.c
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.c
@@ -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
     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
 \r
     @retval DMI_SUCCESS   Buffer contains the required structure data\r
                           Handle is updated with next structure handle or\r

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.h b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.h
index 76442cdf1a24bf28051f1923b3ffaa038c720969..5a9b2ad626a88ff41780bc2c93a7c024ebb7e958 100644 (file)
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.h
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.h
@@ -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
     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
 \r
     @retval DMI_SUCCESS   Buffer contains the required structure data\r
                           Handle is updated with next structure handle or\r

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/PrintInfo.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/PrintInfo.c
index 7a7caac456a44bb7954b83eed3fbb89413e6a432..7c081bdf8a5434eb4738cbaca8e80e9e22bbf5b6 100644 (file)
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/PrintInfo.c
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/PrintInfo.c
@@ -82,9 +82,9 @@
   Copy Length of Src buffer to Dest buffer,\r
   add a NULL termination to Dest buffer.\r
 \r
   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
 **/\r
 VOID\r
 MemToString (\r

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.c
index d84ab10c298a1c528a7727a89451d7b9fd1f7fd5..64997284b078cdafa36999869f3053863fdf4078 100644 (file)
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.c
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.c
@@ -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
     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
 \r
   @return the found Key and Info is valid.\r
   @retval QUERY_TABLE_UNFOUND and Info should be NULL.\r

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.h b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.h
index 6809820232c91f4d153df347074e01d1ad7416bd..5a0c5e05c0df4f40ad146d67d2c258b59bf267a3 100644 (file)
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.h
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.h
@@ -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
     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
 \r
   @return the found Key and Info is valid.\r
   @retval QUERY_TABLE_UNFOUND and Info should be NULL.\r

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.c
index f3cc8d9ce9659f06d7d9f9352b8febcac0e13ed1..b54d8e1f28f4a259d1045963dbf4d7f373db571a 100644 (file)
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.c
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.c
@@ -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
   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
 \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
 /**\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
 \r
   @retval EFI_INVALID_PARAMETER   A parameter was invalid.\r
   @retval EFI_SUCCESS             The conversion was successful.\r

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.h b/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.h
index 3db03c8fab09f2f01261b4b632db2e2992a6e5a0..7cabfe3278d3576737294ab9a3f390a89ad9444d 100644 (file)
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.h
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.h
@@ -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
   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
 \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
 /**\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
 **/\r
 EFI_STATUS\r
 EFIAPI\r

diff --git a/ShellPkg/Library/UefiShellDriver1CommandsLib/Devices.c b/ShellPkg/Library/UefiShellDriver1CommandsLib/Devices.c
index a6e27e93dac620566f063a1cfc13ffdac6f048a5..7998bde8c61821c873f44fc8275d9b5355c49013 100644 (file)
--- a/ShellPkg/Library/UefiShellDriver1CommandsLib/Devices.c
+++ b/ShellPkg/Library/UefiShellDriver1CommandsLib/Devices.c
@@ -17,25 +17,25 @@
 /**\r
   Get lots of info about a device from its handle.\r
 \r
 /**\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
 \r
   @retval EFI_SUCCESS           The info is there.\r
   @retval EFI_INVALID_PARAMETER A parameter was invalid.\r

diff --git a/ShellPkg/Library/UefiShellInstall1CommandsLib/Bcfg.c b/ShellPkg/Library/UefiShellInstall1CommandsLib/Bcfg.c
index 78a4bd23d354efca3dc48b51c4976deb51b303ea..01f04a5472416dcf1cc12f70f68a73645e313164 100644 (file)
--- a/ShellPkg/Library/UefiShellInstall1CommandsLib/Bcfg.c
+++ b/ShellPkg/Library/UefiShellInstall1CommandsLib/Bcfg.c
@@ -49,8 +49,9 @@ typedef struct {
 \r
 /**\r
   This function will populate the device path protocol parameter based on TheHandle.\r
 \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
 \r
   @retval EFI_SUCCESS           The device path was sucessfully returned.\r
   @retval other                 A error from gBS->HandleProtocol.\r

diff --git a/ShellPkg/Library/UefiShellLevel1CommandsLib/For.c b/ShellPkg/Library/UefiShellLevel1CommandsLib/For.c
index bc26ed31bca6d684e2bfaa751f5f11cdd299bbd5..4a85708d0bf34f2a54b7a9c6be412031f8f8fdf4 100644 (file)
--- a/ShellPkg/Library/UefiShellLevel1CommandsLib/For.c
+++ b/ShellPkg/Library/UefiShellLevel1CommandsLib/For.c
@@ -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
 /**\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
 \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
 /**\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
 **/\r
 BOOLEAN\r
 EFIAPI\r

diff --git a/ShellPkg/Library/UefiShellLevel1CommandsLib/If.c b/ShellPkg/Library/UefiShellLevel1CommandsLib/If.c
index b7f423ff4dc6b248ffe7dc74d644561a5ebbf613..d305306124e29b3bdd3df5db54ab011d924e8842 100644 (file)
--- a/ShellPkg/Library/UefiShellLevel1CommandsLib/If.c
+++ b/ShellPkg/Library/UefiShellLevel1CommandsLib/If.c
@@ -40,8 +40,8 @@ typedef enum {
 /**\r
   Extract the next fragment, if there is one.\r
 \r
 /**\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
 \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
 /**\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
 \r
   @retval EFI_INVALID_PARAMETER   A parameter was invalid.\r
   @retval EFI_SUCCESS             The operation was successful.                                  \r

diff --git a/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.c b/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.c
index 72c5d07d520c469f3693ad7973aee18c044d8843..7fc8690ceb6720539b2618af61765bc8030e3ebf 100644 (file)
--- a/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.c
+++ b/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.c
@@ -112,17 +112,17 @@ ShellLevel1CommandsLibDestructor (
 \r
   If label is used it will be used instead of the count.\r
 \r
 \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
 **/\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
 \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
 **/\r
 BOOLEAN\r
 EFIAPI\r

diff --git a/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.h b/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.h
index 7b3efd2f2cb92990f8b439f5dc236569dcf310e3..e8439e7a8bcd95c88e81f335455a03ffa312876f 100644 (file)
--- a/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.h
+++ b/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.h
@@ -182,17 +182,17 @@ LIST_ENTRY *
 \r
   If label is used it will be used instead of the count.\r
 \r
 \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
 **/\r
 BOOLEAN\r
 EFIAPI\r

diff --git a/ShellPkg/Library/UefiShellLevel2CommandsLib/Mv.c b/ShellPkg/Library/UefiShellLevel2CommandsLib/Mv.c
index 5afcea23107fd62d9955d4447eaa171b25dfa170..b83eede5a90cec90289a1854fa5438931b6b1afe 100644 (file)
--- a/ShellPkg/Library/UefiShellLevel2CommandsLib/Mv.c
+++ b/ShellPkg/Library/UefiShellLevel2CommandsLib/Mv.c
@@ -116,9 +116,9 @@ IsValidMove(
 \r
   if the result is sucessful the caller must free *DestPathPointer.\r
 \r
 \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
 \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

diff --git a/ShellPkg/Library/UefiShellLib/UefiShellLib.c b/ShellPkg/Library/UefiShellLib/UefiShellLib.c
index e824895cdb45881c15daa4994676fa6eb32ec0d7..598a2b479a81f29c77ade7464c9727038e065ffc 100644 (file)
--- a/ShellPkg/Library/UefiShellLib/UefiShellLib.c
+++ b/ShellPkg/Library/UefiShellLib/UefiShellLib.c
@@ -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
   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
 \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
 \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
 \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
   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
                                 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
   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
 \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
   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
 \r
   @retval EFI_SUCCESS           The operation was successful.  The line is stored in\r
                                 Buffer.\r

diff --git a/ShellPkg/Library/UefiShellNetwork1CommandsLib/Ifconfig.c b/ShellPkg/Library/UefiShellNetwork1CommandsLib/Ifconfig.c
index 13d24969f85f42876e254df4f1ee8378ed0a951d..b4c423384908ae6f6689837d9d33d560629a2205 100644 (file)
--- a/ShellPkg/Library/UefiShellNetwork1CommandsLib/Ifconfig.c
+++ b/ShellPkg/Library/UefiShellNetwork1CommandsLib/Ifconfig.c
@@ -249,10 +249,10 @@ GetChildHandle (
 /**\r
   Append OFFSET/WIDTH/VALUE items at the beginning of string.\r
 \r
 /**\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
 \r
   @return The count of unicode character that were appended.\r
 **/\r

diff --git a/ShellPkg/Library/UefiSortLib/UefiSortLib.c b/ShellPkg/Library/UefiSortLib/UefiSortLib.c
index 4b89358f1a59946eb705c6eaae90aa2a5f04b84c..73ee7830fc46c79597c6175721a566c7f1393aa1 100644 (file)
--- a/ShellPkg/Library/UefiSortLib/UefiSortLib.c
+++ b/ShellPkg/Library/UefiSortLib/UefiSortLib.c
@@ -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
   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
 **/\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
   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
 **/\r
 VOID\r
 EFIAPI\r