fixing errors found in code review.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9450 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/ShellPkg/Include/Guid/ShellEnvironment2Ext.h b/ShellPkg/Include/Guid/ShellEnvironment2Ext.h
index 49770057be8d5f113f45caccf25f639a52d287d4..b0899c27a2d57918b99e96d49903d01fee0a57bc 100644 (file)
--- a/ShellPkg/Include/Guid/ShellEnvironment2Ext.h
+++ b/ShellPkg/Include/Guid/ShellEnvironment2Ext.h
@@ -18,7 +18,7 @@
 #define SHELLPKG_SHELL_ENV2_EXT_GUID \\r
 { \\r
   0xd2c18636, 0x40e5, 0x4eb5, {0xa3, 0x1b, 0x36, 0x69, 0x5f, 0xd4, 0x2c, 0x87} \\r
-};\r
+}\r
 \r
 extern EFI_GUID gEfiShellEnvironment2ExtGuid;\r
 \r

diff --git a/ShellPkg/Include/Protocol/EfiShell.h b/ShellPkg/Include/Protocol/EfiShell.h
index 8b489dac6bc0428052bdb30a1a0e5701e22fa3f6..11ee58a75ce21ec0c5152e3dfe32d052c448ecc9 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;          /// 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
+  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

diff --git a/ShellPkg/Include/Protocol/EfiShellParameters.h b/ShellPkg/Include/Protocol/EfiShellParameters.h
index 49ad2fdc4332c9f145727eeb93c2969f91d4b094..8f6658b6b5139ac77067193318eb414bb94b9e6f 100644 (file)
--- a/ShellPkg/Include/Protocol/EfiShellParameters.h
+++ b/ShellPkg/Include/Protocol/EfiShellParameters.h
@@ -21,10 +21,35 @@
   }\r
 \r
 typedef struct _EFI_SHELL_PARAMETERS_PROTOCOL {\r
+///\r
+/// Points to an Argc-element array of points to null-terminated strings containing\r
+/// the command-line parameters. The first entry in the array is always the full file\r
+/// path of the executable. Any quotation marks that were used to preserve\r
+/// whitespace have been removed.\r
+///\r
   CHAR16 **Argv;\r
+\r
+///\r
+/// The number of elements in the Argv array.\r
+/// \r
   UINTN Argc;\r
+\r
+///\r
+/// The file handle for the standard input for this executable. This may be different\r
+/// from the ConInHandle in the EFI_SYSTEM_TABLE.\r
+///\r
   EFI_FILE_HANDLE StdIn;\r
+\r
+///\r
+/// The file handle for the standard output for this executable. This may be different\r
+/// from the ConOutHandle in the EFI_SYSTEM_TABLE.\r
+///\r
   EFI_FILE_HANDLE StdOut;\r
+\r
+///\r
+/// The file handle for the standard error output for this executable. This may be\r
+/// different from the StdErrHandle in the EFI_SYSTEM_TABLE.\r
+///\r
   EFI_FILE_HANDLE StdErr;\r
 } EFI_SHELL_PARAMETERS_PROTOCOL;\r
 \r

diff --git a/ShellPkg/Include/ShellBase.h b/ShellPkg/Include/ShellBase.h
index 3929df7b77c3ba1193bdf5cf67c7df65a1fd123b..d5f0b03eec30db1ff19671aecb0dde89715662f2 100644 (file)
--- a/ShellPkg/Include/ShellBase.h
+++ b/ShellPkg/Include/ShellBase.h
@@ -138,9 +138,10 @@ SHELL_INCOMPATIBLE_VERSION  = 25,
 SHELL_SECURITY_VIOLATION    = 26,\r
 \r
 ///\r
-/// A CRC error was detected.\r
+/// The function was performed and resulted in an unequal\r
+/// comparison..\r
 ///\r
-SHELL_CRC_ERROR             = 27\r
+SHELL_NOT_EQUAL             = 27\r
 }SHELL_STATUS;\r
 \r
 #endif //__SHELL_BASE__
\ No newline at end of file