fixing errors found in code review.

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

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