]> git.proxmox.com Git - mirror_edk2.git/blobdiff - ShellPkg/Include/Library/FileHandleLib.h
Refine comments and two code style.
[mirror_edk2.git] / ShellPkg / Include / Library / FileHandleLib.h
index b4c2e7ddee294f789d808365d6e115c60d73d429..a21e20ed95ef112c943c8a64f7c3ccc885cfaf03 100644 (file)
@@ -82,10 +82,10 @@ FileHandleSetInfo (
   are no more directory entries, the read returns a zero-length buffer.\r
   EFI_FILE_INFO is the structure returned as the directory entry.\r
 \r
-  @param[in] FileHandle         The opened file handle.\r
-  @param[in,out] BufferSize     On input, the size of buffer in bytes.  On return,\r
-                                the number of bytes written.\r
-  @param[out] Buffer            The buffer to put read data into.\r
+  @param[in] FileHandle          The opened file handle.\r
+  @param[in, out] BufferSize     On input, the size of buffer in bytes.  On return,\r
+                                 the number of bytes written.\r
+  @param[out] Buffer             The buffer to put read data into.\r
 \r
   @retval EFI_SUCCESS          Data was read.\r
   @retval EFI_NO_MEDIA         The device has no media.\r
@@ -113,10 +113,10 @@ FileHandleRead(
   The file is automatically grown to hold the data if required. Direct writes to\r
   opened directories are not supported.\r
 \r
-  @param[in] FileHandle         The opened file for writing.\r
-  @param[in,out] BufferSize     On input, the number of bytes in Buffer.  On output,\r
-                                the number of bytes written.\r
-  @param[in] Buffer             The buffer containing data to write is stored.\r
+  @param[in] FileHandle          The opened file for writing.\r
+  @param[in, out] BufferSize     On input, the number of bytes in Buffer.  On output,\r
+                                 the number of bytes written.\r
+  @param[in] Buffer              The buffer containing data to write is stored.\r
 \r
   @retval EFI_SUCCESS          Data was written.\r
   @retval EFI_UNSUPPORTED       Writes to an open directory are not supported.\r
@@ -379,17 +379,17 @@ FileHandleGetFileName (
   If the position upon start is 0, then the Ascii Boolean will be set.  This should be\r
   maintained and not changed for all operations with the same file.\r
 \r
-  @param[in]      Handle        FileHandle to read from.\r
-  @param[in,out]  Buffer        The pointer to buffer to read into.\r
-  @param[in,out]  Size          The pointer to number of bytes in Buffer.\r
-  @param[in]      Truncate      If the buffer is large enough, this has no effect.\r
-                                If the buffer is is too small and Truncate is TRUE,\r
-                                the line will be truncated.\r
-                                If the buffer is is too small and Truncate is FALSE,\r
-                                then no read will occur.\r
+  @param[in]       Handle        FileHandle to read from.\r
+  @param[in, out]  Buffer        The pointer to buffer to read into.\r
+  @param[in, out]  Size          The pointer to number of bytes in Buffer.\r
+  @param[in]       Truncate      If the buffer is large enough, this has no effect.\r
+                                 If the buffer is is too small and Truncate is TRUE,\r
+                                 the line will be truncated.\r
+                                 If the buffer is is too small and Truncate is FALSE,\r
+                                 then no read will occur.\r
 \r
-  @param[in,out]  Ascii         Boolean value for indicating whether the file is\r
-                                Ascii (TRUE) or UCS2 (FALSE).\r
+  @param[in, out]  Ascii         Boolean value for indicating whether the file is\r
+                                 Ascii (TRUE) or UCS2 (FALSE).\r
 \r
   @retval EFI_SUCCESS           The operation was successful.  The line is stored in\r
                                 Buffer.\r
@@ -416,9 +416,9 @@ FileHandleReadLine(
   If the position upon start is 0, then the Ascii Boolean will be set.  This should be\r
   maintained and not changed for all operations with the same file.\r
 \r
-  @param[in]      Handle        FileHandle to read from.\r
-  @param[in,out]  Ascii         Boolean value for indicating whether the file is\r
-                                Ascii (TRUE) or UCS2 (FALSE).\r
+  @param[in]       Handle        FileHandle to read from.\r
+  @param[in, out]  Ascii         Boolean value for indicating whether the file is\r
+                                 Ascii (TRUE) or UCS2 (FALSE).\r
 \r
   @return                       The line of text from the file.\r
 \r