updating headers from code review.

[mirror_edk2.git] / ShellPkg / Include / Protocol / EfiShell.h

diff --git a/ShellPkg/Include/Protocol/EfiShell.h b/ShellPkg/Include/Protocol/EfiShell.h
index 658f892f07c4efbe923efd0a0481c07458e40139..8b489dac6bc0428052bdb30a1a0e5701e22fa3f6 100644 (file)
--- a/ShellPkg/Include/Protocol/EfiShell.h
+++ b/ShellPkg/Include/Protocol/EfiShell.h
@@ -26,12 +26,12 @@
 // replaced EFI_LIST_ENTRY with LIST_ENTRY for simplicity.\r
 // they are identical outside of the name.\r
 typedef struct {\r
-  LIST_ENTRY Link;\r
-  EFI_STATUS Status;\r
-  CONST CHAR16 *FullName;\r
-  CONST CHAR16 *FileName;\r
-  EFI_FILE_HANDLE Handle;\r
-  EFI_FILE_INFO *Info;\r
+  LIST_ENTRY Link;          /// Linked list members\r
+  EFI_STATUS Status;        /// Status of opening the file.  Valid only if Handle != NULL.\r
+  CONST CHAR16 *FullName;   /// Fully qualified filename.\r
+  CONST CHAR16 *FileName;   /// name of this file.\r
+  EFI_FILE_HANDLE Handle;   /// Handle for interacting with the opened file or NULL if closed.\r
+  EFI_FILE_INFO *Info;      /// Pointer to the FileInfo struct for this file or NULL.\r
 } EFI_SHELL_FILE_INFO;\r
 /**\r
   Returns whether any script files are currently being processed.\r
@@ -85,7 +85,7 @@ EFI_STATUS
   @retval EFI_SUCCESS       The file was opened.  FileHandle points to the new file's handle.\r
   @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
   @retval EFI_UNSUPPORTED   could not open the file path\r
-  @retval EFI_NOT_FOUND     the specified file could not be found on the devide, or could not\r
+  @retval EFI_NOT_FOUND     The specified file could not be found on the device, or could not\r
                             file the file system on the device.\r
   @retval EFI_NO_MEDIA      the device has no medium.\r
   @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no\r
@@ -846,10 +846,10 @@ EFI_STATUS
   For a description of volatile and non-volatile environment variables, see UEFI Shell \r
   2.0 specification section 3.6.1.\r
 \r
-  @param[in] Name                   Points to the null-terminated environment variable name.\r
-  @param[in] Value                  Points to the null-terminated environment variable value. If the value is an\r
+  @param[in] Name               Points to the null-terminated environment variable name.\r
+  @param[in] Value              Points to the null-terminated environment variable value. If the value is an\r
                                 empty string then the environment variable is deleted.\r
-  @param[in] Volatile               Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).\r
+  @param[in] Volatile           Indicates whether the variable is non-volatile (FALSE) or volatile (TRUE).\r
 \r
   @retval EFI_SUCCESS           The environment variable was successfully updated.\r
 **/\r