Refine comments and two code style.

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

diff --git a/ShellPkg/Application/Shell/FileHandleWrappers.c b/ShellPkg/Application/Shell/FileHandleWrappers.c
index b2163bebb950cab8185bfe72f8cd7e8671807e5d..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
-  @param[in] This             Ignored.\r
-  @param[in] InformationType  Ignored.\r
-  @param[in,out] BufferSize   Ignored.\r
-  @param[out] Buffer          Ignored.\r
+  @param[in] This              Ignored.\r
+  @param[in] InformationType   Ignored.\r
+  @param[in, out] BufferSize   Ignored.\r
+  @param[out] Buffer           Ignored.\r
   \r
   @retval EFI_UNSUPPORTED\r
 **/\r
@@ -141,9 +141,9 @@ FileInterfaceNopSetInfo(
 \r
   Writes data to the screen.\r
   \r
-  @param[in] This             The pointer to the EFI_FILE_PROTOCOL object.\r
-  @param[in,out] BufferSize   Size in bytes of Buffer.\r
-  @param[in] Buffer           The pointer to the buffer to write.\r
+  @param[in] This              The pointer to the EFI_FILE_PROTOCOL object.\r
+  @param[in, out] BufferSize   Size in bytes of Buffer.\r
+  @param[in] Buffer            The pointer to the buffer to write.\r
   \r
   @retval EFI_UNSUPPORTED No output console is supported.\r
   @return A return value from gST->ConOut->OutputString.\r
@@ -166,9 +166,9 @@ FileInterfaceStdOutWrite(
 /**\r
   File style interface for StdIn (Write).\r
   \r
-  @param[in] This           Ignored.\r
-  @param[in,out] BufferSize Ignored.\r
-  @param[in] Buffer         Ignored.\r
+  @param[in] This            Ignored.\r
+  @param[in, out] BufferSize Ignored.\r
+  @param[in] Buffer          Ignored.\r
   \r
   @retval EFI_UNSUPPORTED\r
 **/\r
@@ -188,9 +188,9 @@ FileInterfaceStdInWrite(
 \r
   Writes error to the error output.\r
   \r
-  @param[in] This             The pointer to the EFI_FILE_PROTOCOL object.\r
-  @param[in,out] BufferSize   Size in bytes of Buffer.\r
-  @param[in] Buffer           The pointer to the buffer to write.\r
+  @param[in] This              The pointer to the EFI_FILE_PROTOCOL object.\r
+  @param[in, out] BufferSize   Size in bytes of Buffer.\r
+  @param[in] Buffer            The pointer to the buffer to write.\r
   \r
   @return A return value from gST->StdErr->OutputString.\r
 **/\r
@@ -208,9 +208,9 @@ FileInterfaceStdErrWrite(
 /**\r
   File style interface for console StdOut (Read).\r
   \r
-  @param[in] This             Ignored.\r
-  @param[in,out] BufferSize   Ignored.\r
-  @param[out] Buffer          Ignored.\r
+  @param[in] This              Ignored.\r
+  @param[in, out] BufferSize   Ignored.\r
+  @param[out] Buffer           Ignored.\r
   \r
   @retval EFI_UNSUPPORTED\r
 **/\r
@@ -228,9 +228,9 @@ FileInterfaceStdOutRead(
 /**\r
   File style interface for console StdErr (Read).\r
   \r
-  @param[in] This             Ignored.\r
-  @param[in,out] BufferSize   Ignored.\r
-  @param[out] Buffer          Ignored.\r
+  @param[in] This              Ignored.\r
+  @param[in, out] BufferSize   Ignored.\r
+  @param[out] Buffer           Ignored.\r
   \r
   @retval EFI_UNSUPPORTED Always.\r
 **/\r
@@ -248,9 +248,9 @@ FileInterfaceStdErrRead(
 /**\r
   File style interface for NUL file (Read).\r
   \r
-  @param[in] This             Ignored.\r
-  @param[in,out] BufferSize   Ignored.\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
@@ -262,15 +262,16 @@ FileInterfaceNulRead(
   OUT     VOID              *Buffer\r
   )\r
 {\r
+  *BufferSize = 0;\r
   return (EFI_SUCCESS);\r
 }\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
@@ -521,7 +522,7 @@ FileInterfaceStdInRead(
         }\r
         StrCat(TabStr, L"*");\r
         FoundFileList = NULL;\r
-//        TabStr = CleanPath(TabStr);\r
+//        TabStr = PathCleanUpDirectories(TabStr);\r
         Status  = ShellInfoObject.NewEfiShellProtocol->FindFiles(TabStr, &FoundFileList);\r
         for ( TempStr = CurrentString\r
             ; *TempStr == L' '\r
@@ -973,9 +974,9 @@ FileInterfaceEnvDelete(
 /**\r
   File style interface for Environment Variable (Read).\r
   \r
-  @param[in] This             The pointer to the EFI_FILE_PROTOCOL object.\r
-  @param[in,out] BufferSize   Size in bytes of Buffer.\r
-  @param[out] Buffer          The pointer to the buffer to fill.\r
+  @param[in] This              The pointer to the EFI_FILE_PROTOCOL object.\r
+  @param[in, out] BufferSize   Size in bytes of Buffer.\r
+  @param[out] Buffer           The pointer to the buffer to fill.\r
   \r
   @retval EFI_SUCCESS   The data was read.\r
 **/\r
@@ -996,9 +997,9 @@ FileInterfaceEnvRead(
 /**\r
   File style interface for Volatile Environment Variable (Write).\r
   \r
-  @param[in] This             The pointer to the EFI_FILE_PROTOCOL object.\r
-  @param[in,out] BufferSize   Size in bytes of Buffer.\r
-  @param[in] Buffer           The pointer to the buffer to write.\r
+  @param[in] This              The pointer to the EFI_FILE_PROTOCOL object.\r
+  @param[in, out] BufferSize   Size in bytes of Buffer.\r
+  @param[in] Buffer            The pointer to the buffer to write.\r
   \r
   @retval EFI_SUCCESS   The data was read.\r
 **/\r
@@ -1043,9 +1044,9 @@ FileInterfaceEnvVolWrite(
 /**\r
   File style interface for Non Volatile Environment Variable (Write).\r
   \r
-  @param[in] This             The pointer to the EFI_FILE_PROTOCOL object.\r
-  @param[in,out] BufferSize   Size in bytes of Buffer.\r
-  @param[in] Buffer           The pointer to the buffer to write.\r
+  @param[in] This              The pointer to the EFI_FILE_PROTOCOL object.\r
+  @param[in, out] BufferSize   Size in bytes of Buffer.\r
+  @param[in] Buffer            The pointer to the buffer to write.\r
   \r
   @retval EFI_SUCCESS   The data was read.\r
 **/\r
@@ -1143,8 +1144,8 @@ CreateFileInterfaceEnv(
   Move the cursor position one character backward.\r
 \r
   @param[in] LineLength       Length of a line. Get it by calling QueryMode\r
-  @param[in,out] Column      Current column of the cursor position\r
-  @param[in,out] Row         Current row of the cursor position\r
+  @param[in, out] Column      Current column of the cursor position\r
+  @param[in, out] Row         Current row of the cursor position\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -1173,8 +1174,8 @@ MoveCursorBackward (
 \r
   @param[in] LineLength       Length of a line.\r
   @param[in] TotalRow         Total row of a screen\r
-  @param[in,out] Column      Current column of the cursor position\r
-  @param[in,out] Row         Current row of the cursor position\r
+  @param[in, out] Column      Current column of the cursor position\r
+  @param[in, out] Row         Current row of the cursor position\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -1322,9 +1323,9 @@ FileInterfaceMemGetPosition(
 /**\r
   File style interface for Mem (Write).\r
   \r
-  @param[in] This             The pointer to the EFI_FILE_PROTOCOL object.\r
-  @param[in,out] BufferSize   Size in bytes of Buffer.\r
-  @param[in] Buffer           The pointer to the buffer to write.\r
+  @param[in] This              The pointer to the EFI_FILE_PROTOCOL object.\r
+  @param[in, out] BufferSize   Size in bytes of Buffer.\r
+  @param[in] Buffer            The pointer to the buffer to write.\r
   \r
   @retval EFI_SUCCESS   The data was written.\r
 **/\r
@@ -1368,9 +1369,9 @@ FileInterfaceMemWrite(
 /**\r
   File style interface for Mem (Read).\r
   \r
-  @param[in] This             The pointer to the EFI_FILE_PROTOCOL object.\r
-  @param[in,out] BufferSize   Size in bytes of Buffer.\r
-  @param[in] Buffer           The pointer to the buffer to fill.\r
+  @param[in] This              The pointer to the EFI_FILE_PROTOCOL object.\r
+  @param[in, out] BufferSize   Size in bytes of Buffer.\r
+  @param[in] Buffer            The pointer to the buffer to fill.\r
   \r
   @retval EFI_SUCCESS   The data was read.\r
 **/\r
@@ -1717,9 +1718,9 @@ FileInterfaceFileClose(
   If the file was opened with ASCII mode the data will be processed through \r
   AsciiSPrint before writing.\r
   \r
-  @param[in] This             The pointer to the EFI_FILE_PROTOCOL object.\r
-  @param[in,out] BufferSize   Size in bytes of Buffer.\r
-  @param[in] Buffer           The pointer to the buffer to write.\r
+  @param[in] This              The pointer to the EFI_FILE_PROTOCOL object.\r
+  @param[in, out] BufferSize   Size in bytes of Buffer.\r
+  @param[in] Buffer            The pointer to the buffer to write.\r
   \r
   @retval EFI_SUCCESS   The data was written.\r
 **/\r