]> git.proxmox.com Git - mirror_edk2.git/blobdiff - ShellPkg/Include/Protocol/EfiShell.h
Refine comments and two code style.
[mirror_edk2.git] / ShellPkg / Include / Protocol / EfiShell.h
index ce38e0e439061699984402fe094eae08c7d7c094..d36c1f6b17da2347c834bb1b53663e7d491e868b 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   EFI Shell protocol as defined in the UEFI Shell 2.0 specification including errata.\r
 \r
-  Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved.<BR>\r
+  Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
@@ -341,7 +341,7 @@ typedef UINT32 EFI_SHELL_DEVICE_NAME_FLAGS;
 **/\r
 typedef\r
 EFI_STATUS\r
-(*EFI_SHELL_GET_DEVICE_NAME) (\r
+(EFIAPI *EFI_SHELL_GET_DEVICE_NAME) (\r
   IN EFI_HANDLE                   DeviceHandle,\r
   IN EFI_SHELL_DEVICE_NAME_FLAGS  Flags,\r
   IN CHAR8                        *Language,\r
@@ -531,9 +531,9 @@ EFI_STATUS
   If there are multiple map names they will be semi-colon seperated in the\r
   NULL-terminated string.\r
 \r
-  @param[in,out] DevicePath     On entry, points to a device path pointer. On\r
-                                exit, updates the pointer to point to the\r
-                                portion of the device path after the mapping.\r
+  @param[in, out] DevicePath     On entry, points to a device path pointer. On\r
+                                 exit, updates the pointer to point to the\r
+                                 portion of the device path after the mapping.\r
 \r
   @retval NULL                  No mapping was found.\r
   @retval !=NULL                Pointer to NULL-terminated mapping. The buffer\r
@@ -640,10 +640,10 @@ EFI_STATUS
   according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each\r
   matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.\r
 \r
-  @param[in] Path               A pointer to the path string.\r
-  @param[in] OpenMode           Specifies the mode used to open each file, EFI_FILE_MODE_READ or\r
-                                EFI_FILE_MODE_WRITE.\r
-  @param[in,out] FileList       Points to the start of a list of files opened.\r
+  @param[in] Path                A pointer to the path string.\r
+  @param[in] OpenMode            Specifies the mode used to open each file, EFI_FILE_MODE_READ or\r
+                                 EFI_FILE_MODE_WRITE.\r
+  @param[in, out] FileList       Points to the start of a list of files opened.\r
 \r
   @retval EFI_SUCCESS           Create the file list successfully.\r
   @return                       Can't create the file list.\r
@@ -710,9 +710,9 @@ EFI_STATUS
   current position is increased by the number of bytes returned.\r
   If FileHandle is a directory, then an error is returned.\r
 \r
-  @param[in] FileHandle         The opened file handle for read.\r
-  @param[in] ReadSize           On input, the size of Buffer, in bytes. On output, the amount of data read.\r
-  @param[in,out] Buffer         The buffer in which data is read.\r
+  @param[in] FileHandle          The opened file handle for read.\r
+  @param[in] ReadSize            On input, the size of Buffer, in bytes. On output, the amount of data read.\r
+  @param[in, out] Buffer         The buffer in which data is read.\r
 \r
   @retval EFI_SUCCESS           Data was read.\r
   @retval EFI_NO_MEDIA          The device has no media.\r
@@ -929,9 +929,9 @@ EFI_STATUS
 \r
   Direct writes to opened directories are not supported.\r
 \r
-  @param[in] FileHandle             The opened file handle for writing.\r
-  @param[in,out] BufferSize         On input, size of Buffer.\r
-  @param[in] Buffer                 The buffer in which data to write.\r
+  @param[in] FileHandle              The opened file handle for writing.\r
+  @param[in, out] BufferSize         On input, size of Buffer.\r
+  @param[in] Buffer                  The buffer in which data to write.\r
 \r
   @retval EFI_SUCCESS               Data was written.\r
   @retval EFI_UNSUPPORTED           Writes to open directory are not supported.\r