From 4ff7e37b4f7e336a8ecb7080b8f48eef4b52d396 Mon Sep 17 00:00:00 2001 From: ydong10 Date: Fri, 2 Sep 2011 08:05:34 +0000 Subject: Refine comments and two code style. Signed-off-by: ydong10 git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@12263 6f19259b-4bc3-4df7-8a09-765794883524 --- ShellPkg/Application/Shell/ConsoleLogger.h | 2 +- ShellPkg/Application/Shell/ConsoleWrappers.c | 4 +- ShellPkg/Application/Shell/FileHandleInternal.h | 8 +- ShellPkg/Application/Shell/FileHandleWrappers.c | 94 +++++++++++----------- ShellPkg/Application/Shell/Shell.c | 12 +-- ShellPkg/Application/Shell/Shell.h | 4 +- ShellPkg/Application/Shell/ShellEnvVar.c | 4 +- ShellPkg/Application/Shell/ShellEnvVar.h | 4 +- ShellPkg/Application/Shell/ShellManParser.c | 12 +-- .../Application/Shell/ShellParametersProtocol.c | 52 ++++++------ .../Application/Shell/ShellParametersProtocol.h | 44 +++++----- ShellPkg/Application/Shell/ShellProtocol.c | 20 ++--- ShellPkg/Application/Shell/ShellProtocol.h | 4 +- .../ShellSortTestApp/ShellSortTestApp.c | 4 +- 14 files changed, 134 insertions(+), 134 deletions(-) (limited to 'ShellPkg/Application') diff --git a/ShellPkg/Application/Shell/ConsoleLogger.h b/ShellPkg/Application/Shell/ConsoleLogger.h index f7c5f6a7a2..c470cdb7ab 100644 --- a/ShellPkg/Application/Shell/ConsoleLogger.h +++ b/ShellPkg/Application/Shell/ConsoleLogger.h @@ -80,7 +80,7 @@ ConsoleLoggerInstall( Return the system to the state it was before InstallConsoleLogger was installed. - @param[in,out] ConsoleInfo The object from the install function. + @param[in, out] ConsoleInfo The object from the install function. @retval EFI_SUCCESS The operation was successful @return other The operation failed. This was from UninstallProtocolInterface. diff --git a/ShellPkg/Application/Shell/ConsoleWrappers.c b/ShellPkg/Application/Shell/ConsoleWrappers.c index 3212af9a08..561a666473 100644 --- a/ShellPkg/Application/Shell/ConsoleWrappers.c +++ b/ShellPkg/Application/Shell/ConsoleWrappers.c @@ -81,8 +81,8 @@ FileBasedSimpleTextInReset( /** ReadKeyStroke function for the fake simple text input. - @param[in] This A pointer to the SimpleTextIn structure. - @param[in,out] Key A pointer to the Key structure to fill. + @param[in] This A pointer to the SimpleTextIn structure. + @param[in, out] Key A pointer to the Key structure to fill. @retval EFI_SUCCESS The read was successful. **/ diff --git a/ShellPkg/Application/Shell/FileHandleInternal.h b/ShellPkg/Application/Shell/FileHandleInternal.h index ec55a6e4eb..2aaae34214 100644 --- a/ShellPkg/Application/Shell/FileHandleInternal.h +++ b/ShellPkg/Application/Shell/FileHandleInternal.h @@ -19,8 +19,8 @@ Move the cursor position one character backward. @param[in] LineLength Length of a line. Get it by calling QueryMode - @param[in,out] Column Current column of the cursor position - @param[in,out] Row Current row of the cursor position + @param[in, out] Column Current column of the cursor position + @param[in, out] Row Current row of the cursor position **/ VOID EFIAPI @@ -35,8 +35,8 @@ MoveCursorBackward ( @param[in] LineLength Length of a line. @param[in] TotalRow Total row of a screen - @param[in,out] Column Current column of the cursor position - @param[in,out] Row Current row of the cursor position + @param[in, out] Column Current column of the cursor position + @param[in, out] Row Current row of the cursor position **/ VOID EFIAPI diff --git a/ShellPkg/Application/Shell/FileHandleWrappers.c b/ShellPkg/Application/Shell/FileHandleWrappers.c index 22e8c71d12..2e1ce08ef3 100644 --- a/ShellPkg/Application/Shell/FileHandleWrappers.c +++ b/ShellPkg/Application/Shell/FileHandleWrappers.c @@ -95,10 +95,10 @@ FileInterfaceNopSetPosition( /** File style interface for console (GetInfo). - @param[in] This Ignored. - @param[in] InformationType Ignored. - @param[in,out] BufferSize Ignored. - @param[out] Buffer Ignored. + @param[in] This Ignored. + @param[in] InformationType Ignored. + @param[in, out] BufferSize Ignored. + @param[out] Buffer Ignored. @retval EFI_UNSUPPORTED **/ @@ -141,9 +141,9 @@ FileInterfaceNopSetInfo( Writes data to the screen. - @param[in] This The pointer to the EFI_FILE_PROTOCOL object. - @param[in,out] BufferSize Size in bytes of Buffer. - @param[in] Buffer The pointer to the buffer to write. + @param[in] This The pointer to the EFI_FILE_PROTOCOL object. + @param[in, out] BufferSize Size in bytes of Buffer. + @param[in] Buffer The pointer to the buffer to write. @retval EFI_UNSUPPORTED No output console is supported. @return A return value from gST->ConOut->OutputString. @@ -166,9 +166,9 @@ FileInterfaceStdOutWrite( /** File style interface for StdIn (Write). - @param[in] This Ignored. - @param[in,out] BufferSize Ignored. - @param[in] Buffer Ignored. + @param[in] This Ignored. + @param[in, out] BufferSize Ignored. + @param[in] Buffer Ignored. @retval EFI_UNSUPPORTED **/ @@ -188,9 +188,9 @@ FileInterfaceStdInWrite( Writes error to the error output. - @param[in] This The pointer to the EFI_FILE_PROTOCOL object. - @param[in,out] BufferSize Size in bytes of Buffer. - @param[in] Buffer The pointer to the buffer to write. + @param[in] This The pointer to the EFI_FILE_PROTOCOL object. + @param[in, out] BufferSize Size in bytes of Buffer. + @param[in] Buffer The pointer to the buffer to write. @return A return value from gST->StdErr->OutputString. **/ @@ -208,9 +208,9 @@ FileInterfaceStdErrWrite( /** File style interface for console StdOut (Read). - @param[in] This Ignored. - @param[in,out] BufferSize Ignored. - @param[out] Buffer Ignored. + @param[in] This Ignored. + @param[in, out] BufferSize Ignored. + @param[out] Buffer Ignored. @retval EFI_UNSUPPORTED **/ @@ -228,9 +228,9 @@ FileInterfaceStdOutRead( /** File style interface for console StdErr (Read). - @param[in] This Ignored. - @param[in,out] BufferSize Ignored. - @param[out] Buffer Ignored. + @param[in] This Ignored. + @param[in, out] BufferSize Ignored. + @param[out] Buffer Ignored. @retval EFI_UNSUPPORTED Always. **/ @@ -248,9 +248,9 @@ FileInterfaceStdErrRead( /** File style interface for NUL file (Read). - @param[in] This Ignored. - @param[in,out] BufferSize Poiner to 0 upon return. - @param[out] Buffer Ignored. + @param[in] This Ignored. + @param[in, out] BufferSize Poiner to 0 upon return. + @param[out] Buffer Ignored. @retval EFI_SUCCESS Always. **/ @@ -269,9 +269,9 @@ FileInterfaceNulRead( /** File style interface for NUL file (Write). - @param[in] This Ignored. - @param[in,out] BufferSize Ignored. - @param[in] Buffer Ignored. + @param[in] This Ignored. + @param[in, out] BufferSize Ignored. + @param[in] Buffer Ignored. @retval EFI_SUCCESS **/ @@ -974,9 +974,9 @@ FileInterfaceEnvDelete( /** File style interface for Environment Variable (Read). - @param[in] This The pointer to the EFI_FILE_PROTOCOL object. - @param[in,out] BufferSize Size in bytes of Buffer. - @param[out] Buffer The pointer to the buffer to fill. + @param[in] This The pointer to the EFI_FILE_PROTOCOL object. + @param[in, out] BufferSize Size in bytes of Buffer. + @param[out] Buffer The pointer to the buffer to fill. @retval EFI_SUCCESS The data was read. **/ @@ -997,9 +997,9 @@ FileInterfaceEnvRead( /** File style interface for Volatile Environment Variable (Write). - @param[in] This The pointer to the EFI_FILE_PROTOCOL object. - @param[in,out] BufferSize Size in bytes of Buffer. - @param[in] Buffer The pointer to the buffer to write. + @param[in] This The pointer to the EFI_FILE_PROTOCOL object. + @param[in, out] BufferSize Size in bytes of Buffer. + @param[in] Buffer The pointer to the buffer to write. @retval EFI_SUCCESS The data was read. **/ @@ -1044,9 +1044,9 @@ FileInterfaceEnvVolWrite( /** File style interface for Non Volatile Environment Variable (Write). - @param[in] This The pointer to the EFI_FILE_PROTOCOL object. - @param[in,out] BufferSize Size in bytes of Buffer. - @param[in] Buffer The pointer to the buffer to write. + @param[in] This The pointer to the EFI_FILE_PROTOCOL object. + @param[in, out] BufferSize Size in bytes of Buffer. + @param[in] Buffer The pointer to the buffer to write. @retval EFI_SUCCESS The data was read. **/ @@ -1144,8 +1144,8 @@ CreateFileInterfaceEnv( Move the cursor position one character backward. @param[in] LineLength Length of a line. Get it by calling QueryMode - @param[in,out] Column Current column of the cursor position - @param[in,out] Row Current row of the cursor position + @param[in, out] Column Current column of the cursor position + @param[in, out] Row Current row of the cursor position **/ VOID EFIAPI @@ -1174,8 +1174,8 @@ MoveCursorBackward ( @param[in] LineLength Length of a line. @param[in] TotalRow Total row of a screen - @param[in,out] Column Current column of the cursor position - @param[in,out] Row Current row of the cursor position + @param[in, out] Column Current column of the cursor position + @param[in, out] Row Current row of the cursor position **/ VOID EFIAPI @@ -1323,9 +1323,9 @@ FileInterfaceMemGetPosition( /** File style interface for Mem (Write). - @param[in] This The pointer to the EFI_FILE_PROTOCOL object. - @param[in,out] BufferSize Size in bytes of Buffer. - @param[in] Buffer The pointer to the buffer to write. + @param[in] This The pointer to the EFI_FILE_PROTOCOL object. + @param[in, out] BufferSize Size in bytes of Buffer. + @param[in] Buffer The pointer to the buffer to write. @retval EFI_SUCCESS The data was written. **/ @@ -1369,9 +1369,9 @@ FileInterfaceMemWrite( /** File style interface for Mem (Read). - @param[in] This The pointer to the EFI_FILE_PROTOCOL object. - @param[in,out] BufferSize Size in bytes of Buffer. - @param[in] Buffer The pointer to the buffer to fill. + @param[in] This The pointer to the EFI_FILE_PROTOCOL object. + @param[in, out] BufferSize Size in bytes of Buffer. + @param[in] Buffer The pointer to the buffer to fill. @retval EFI_SUCCESS The data was read. **/ @@ -1718,9 +1718,9 @@ FileInterfaceFileClose( If the file was opened with ASCII mode the data will be processed through AsciiSPrint before writing. - @param[in] This The pointer to the EFI_FILE_PROTOCOL object. - @param[in,out] BufferSize Size in bytes of Buffer. - @param[in] Buffer The pointer to the buffer to write. + @param[in] This The pointer to the EFI_FILE_PROTOCOL object. + @param[in, out] BufferSize Size in bytes of Buffer. + @param[in] Buffer The pointer to the buffer to write. @retval EFI_SUCCESS The data was written. **/ diff --git a/ShellPkg/Application/Shell/Shell.c b/ShellPkg/Application/Shell/Shell.c index e817a11142..3a5899f342 100644 --- a/ShellPkg/Application/Shell/Shell.c +++ b/ShellPkg/Application/Shell/Shell.c @@ -566,8 +566,8 @@ IsScriptOnlyCommand( loaded image protocol installed on it. The FilePath will point to the device path for the file that was loaded. - @param[in,out] DevPath On a sucessful return the device path to the loaded image. - @param[in,out] FilePath On a sucessful return the device path to the file. + @param[in, out] DevPath On a sucessful return the device path to the loaded image. + @param[in, out] FilePath On a sucessful return the device path to the file. @retval EFI_SUCCESS The 2 device paths were sucessfully returned. @retval other A error from gBS->HandleProtocol. @@ -1016,10 +1016,10 @@ AddLineToCommandHistory( Checks if a string is an alias for another command. If yes, then it replaces the alias name with the correct command name. - @param[in,out] CommandString Upon entry the potential alias. Upon return the - command name if it was an alias. If it was not - an alias it will be unchanged. This function may - change the buffer to fit the command name. + @param[in, out] CommandString Upon entry the potential alias. Upon return the + command name if it was an alias. If it was not + an alias it will be unchanged. This function may + change the buffer to fit the command name. @retval EFI_SUCCESS The name was changed. @retval EFI_SUCCESS The name was not an alias. diff --git a/ShellPkg/Application/Shell/Shell.h b/ShellPkg/Application/Shell/Shell.h index e79c5481f3..d01b126075 100644 --- a/ShellPkg/Application/Shell/Shell.h +++ b/ShellPkg/Application/Shell/Shell.h @@ -137,8 +137,8 @@ SetBuiltInAlias( loaded image protocol installed on it. the FilePath will point to the device path for the file that was loaded. - @param[in,out] DevPath on a sucessful return the device path to the loaded image - @param[in,out] FilePath on a sucessful return the device path to the file + @param[in, out] DevPath on a sucessful return the device path to the loaded image + @param[in, out] FilePath on a sucessful return the device path to the file @retval EFI_SUCCESS the 2 device paths were sucessfully returned. @return other a error from gBS->HandleProtocol diff --git a/ShellPkg/Application/Shell/ShellEnvVar.c b/ShellPkg/Application/Shell/ShellEnvVar.c index d674f14c24..a4bd6a6179 100644 --- a/ShellPkg/Application/Shell/ShellEnvVar.c +++ b/ShellPkg/Application/Shell/ShellEnvVar.c @@ -123,8 +123,8 @@ FreeEnvironmentVariableList( /** Creates a list of all Shell-Guid-based environment variables. - @param[in,out] ListHead The pointer to pointer to LIST ENTRY object for - storing this list. + @param[in, out] ListHead The pointer to pointer to LIST ENTRY object for + storing this list. @retval EFI_SUCCESS the list was created sucessfully. **/ diff --git a/ShellPkg/Application/Shell/ShellEnvVar.h b/ShellPkg/Application/Shell/ShellEnvVar.h index 277895994a..ab3d9166db 100644 --- a/ShellPkg/Application/Shell/ShellEnvVar.h +++ b/ShellPkg/Application/Shell/ShellEnvVar.h @@ -145,8 +145,8 @@ IsVolatileEnv ( /** Creates a list of all Shell-Guid-based environment variables. - @param[in,out] List The pointer to pointer to LIST_ENTRY object for - storing this list. + @param[in, out] List The pointer to pointer to LIST_ENTRY object for + storing this list. @retval EFI_SUCCESS the list was created sucessfully. **/ diff --git a/ShellPkg/Application/Shell/ShellManParser.c b/ShellPkg/Application/Shell/ShellManParser.c index ab32c36b75..bcc1f8e0a3 100644 --- a/ShellPkg/Application/Shell/ShellManParser.c +++ b/ShellPkg/Application/Shell/ShellManParser.c @@ -423,12 +423,12 @@ ManBufferFindTitleSection( Upon a sucessful return the caller is responsible to free the memory in *BriefDesc - @param[in] Handle FileHandle to read from - @param[in] Command name of command's section to find - @param[out] BriefDesc pointer to pointer to string where description goes. - @param[out] BriefSize pointer to size of allocated BriefDesc - @param[in,out] Ascii TRUE if the file is ASCII, FALSE otherwise, will be - set if the file handle is at the 0 position. + @param[in] Handle FileHandle to read from + @param[in] Command name of command's section to find + @param[out] BriefDesc pointer to pointer to string where description goes. + @param[out] BriefSize pointer to size of allocated BriefDesc + @param[in, out] Ascii TRUE if the file is ASCII, FALSE otherwise, will be + set if the file handle is at the 0 position. @retval EFI_OUT_OF_RESOURCES a memory allocation failed. @retval EFI_SUCCESS the section was found and its description sotred in diff --git a/ShellPkg/Application/Shell/ShellParametersProtocol.c b/ShellPkg/Application/Shell/ShellParametersProtocol.c index 99a7294842..02606d615b 100644 --- a/ShellPkg/Application/Shell/ShellParametersProtocol.c +++ b/ShellPkg/Application/Shell/ShellParametersProtocol.c @@ -26,9 +26,9 @@ Temp Parameter must be large enough to hold the parameter before calling this function. - @param[in,out] Walker pointer to string of command line. Adjusted to + @param[in, out] Walker pointer to string of command line. Adjusted to reminaing command line on return - @param[in,out] TempParameter pointer to string of command line item extracted. + @param[in, out] TempParameter pointer to string of command line item extracted. **/ VOID @@ -137,9 +137,9 @@ GetNextParameter( parameters for inclusion in EFI_SHELL_PARAMETERS_PROTOCOL. this supports space delimited and quote surrounded parameter definition. - @param[in] CommandLine String of command line to parse - @param[in,out] Argv pointer to array of strings; one for each parameter - @param[in,out] Argc pointer to number of strings in Argv array + @param[in] CommandLine String of command line to parse + @param[in, out] Argv pointer to array of strings; one for each parameter + @param[in, out] Argc pointer to number of strings in Argv array @return EFI_SUCCESS the operation was sucessful @return EFI_OUT_OF_RESOURCES a memory allocation failed. @@ -215,9 +215,9 @@ ParseCommandLineToArgs( installs it on our handle and if there is an existing version of the protocol that one is cached for removal later. - @param[in,out] NewShellParameters on a successful return, a pointer to pointer + @param[in, out] NewShellParameters on a successful return, a pointer to pointer to the newly installed interface. - @param[in,out] RootShellInstance on a successful return, pointer to boolean. + @param[in, out] RootShellInstance on a successful return, pointer to boolean. TRUE if this is the root shell instance. @retval EFI_SUCCESS the operation completed successfully. @@ -449,7 +449,7 @@ IsUnicodeFile( All of the characters between quotes is replaced with spaces. - @param[in,out] TheString A pointer to the string to update. + @param[in, out] TheString A pointer to the string to update. **/ VOID EFIAPI @@ -477,12 +477,12 @@ StripQuotes ( This will also update the system table. - @param[in,out] ShellParameters Pointer to parameter structure to modify. - @param[in] NewCommandLine The new command line to parse and use. - @param[out] OldStdIn Pointer to old StdIn. - @param[out] OldStdOut Pointer to old StdOut. - @param[out] OldStdErr Pointer to old StdErr. - @param[out] SystemTableInfo Pointer to old system table information. + @param[in, out] ShellParameters Pointer to parameter structure to modify. + @param[in] NewCommandLine The new command line to parse and use. + @param[out] OldStdIn Pointer to old StdIn. + @param[out] OldStdOut Pointer to old StdOut. + @param[out] OldStdErr Pointer to old StdErr. + @param[out] SystemTableInfo Pointer to old system table information. @retval EFI_SUCCESS Operation was sucessful, Argv and Argc are valid. @retval EFI_OUT_OF_RESOURCES A memory allocation failed. @@ -1049,11 +1049,11 @@ UpdateStdInStdOutStdErr( Funcion will replace the current StdIn and StdOut in the ShellParameters protocol structure with StdIn and StdOut. The current values are de-allocated. - @param[in,out] ShellParameters Pointer to parameter structure to modify. - @param[in] OldStdIn Pointer to old StdIn. - @param[in] OldStdOut Pointer to old StdOut. - @param[in] OldStdErr Pointer to old StdErr. - @param[in] SystemTableInfo Pointer to old system table information. + @param[in, out] ShellParameters Pointer to parameter structure to modify. + @param[in] OldStdIn Pointer to old StdIn. + @param[in] OldStdOut Pointer to old StdOut. + @param[in] OldStdErr Pointer to old StdErr. + @param[in] SystemTableInfo Pointer to old system table information. **/ EFI_STATUS EFIAPI @@ -1121,10 +1121,10 @@ RestoreStdInStdOutStdErr ( If OldArgv or OldArgc is NULL then that value is not returned. - @param[in,out] ShellParameters Pointer to parameter structure to modify. - @param[in] NewCommandLine The new command line to parse and use. - @param[out] OldArgv Pointer to old list of parameters. - @param[out] OldArgc Pointer to old number of items in Argv list. + @param[in, out] ShellParameters Pointer to parameter structure to modify. + @param[in] NewCommandLine The new command line to parse and use. + @param[out] OldArgv Pointer to old list of parameters. + @param[out] OldArgc Pointer to old number of items in Argv list. @retval EFI_SUCCESS Operation was sucessful, Argv and Argc are valid. @retval EFI_OUT_OF_RESOURCES A memory allocation failed. @@ -1155,9 +1155,9 @@ UpdateArgcArgv( structure with Argv and Argc. The current values are de-allocated and the OldArgv must not be deallocated by the caller. - @param[in,out] ShellParameters pointer to parameter structure to modify - @param[in] OldArgv pointer to old list of parameters - @param[in] OldArgc pointer to old number of items in Argv list + @param[in, out] ShellParameters pointer to parameter structure to modify + @param[in] OldArgv pointer to old list of parameters + @param[in] OldArgc pointer to old number of items in Argv list **/ VOID EFIAPI diff --git a/ShellPkg/Application/Shell/ShellParametersProtocol.h b/ShellPkg/Application/Shell/ShellParametersProtocol.h index df3bfa7cbc..b63e1d394f 100644 --- a/ShellPkg/Application/Shell/ShellParametersProtocol.h +++ b/ShellPkg/Application/Shell/ShellParametersProtocol.h @@ -43,9 +43,9 @@ installs it on our handle and if there is an existing version of the protocol that one is cached for removal later. - @param[in,out] NewShellParameters on a successful return, a pointer to pointer + @param[in, out] NewShellParameters on a successful return, a pointer to pointer to the newly installed interface. - @param[in,out] RootShellInstance on a successful return, pointer to boolean. + @param[in, out] RootShellInstance on a successful return, pointer to boolean. TRUE if this is the root shell instance. @retval EFI_SUCCESS the operation completed successfully. @@ -84,7 +84,7 @@ CleanUpShellParametersProtocol ( structure by parsing NewCommandLine. The current values are returned to the user. - @param[in,out] ShellParameters pointer to parameter structure to modify + @param[in, out] ShellParameters pointer to parameter structure to modify @param[in] NewCommandLine the new command line to parse and use @param[out] OldArgv pointer to old list of parameters @param[out] OldArgc pointer to old number of items in Argv list @@ -106,9 +106,9 @@ UpdateArgcArgv( structure with Argv and Argc. The current values are de-allocated and the OldArgv must not be deallocated by the caller. - @param[in,out] ShellParameters pointer to parameter structure to modify - @param[in] OldArgv pointer to old list of parameters - @param[in] OldArgc pointer to old number of items in Argv list + @param[in, out] ShellParameters pointer to parameter structure to modify + @param[in] OldArgv pointer to old list of parameters + @param[in] OldArgc pointer to old number of items in Argv list **/ VOID EFIAPI @@ -134,12 +134,12 @@ typedef struct { This will also update the system table. - @param[in,out] ShellParameters Pointer to parameter structure to modify. - @param[in] NewCommandLine The new command line to parse and use. - @param[out] OldStdIn Pointer to old StdIn. - @param[out] OldStdOut Pointer to old StdOut. - @param[out] OldStdErr Pointer to old StdErr. - @param[out] SystemTableInfo Pointer to old system table information. + @param[in, out] ShellParameters Pointer to parameter structure to modify. + @param[in] NewCommandLine The new command line to parse and use. + @param[out] OldStdIn Pointer to old StdIn. + @param[out] OldStdOut Pointer to old StdOut. + @param[out] OldStdErr Pointer to old StdErr. + @param[out] SystemTableInfo Pointer to old system table information. @retval EFI_SUCCESS Operation was sucessful, Argv and Argc are valid. @retval EFI_OUT_OF_RESOURCES A memory allocation failed. @@ -159,11 +159,11 @@ UpdateStdInStdOutStdErr( Funcion will replace the current StdIn and StdOut in the ShellParameters protocol structure with StdIn and StdOut. The current values are de-allocated. - @param[in,out] ShellParameters Pointer to parameter structure to modify. - @param[in] OldStdIn Pointer to old StdIn. - @param[in] OldStdOut Pointer to old StdOut. - @param[in] OldStdErr Pointer to old StdErr. - @param[in] SystemTableInfo Pointer to old system table information. + @param[in, out] ShellParameters Pointer to parameter structure to modify. + @param[in] OldStdIn Pointer to old StdIn. + @param[in] OldStdOut Pointer to old StdOut. + @param[in] OldStdErr Pointer to old StdErr. + @param[in] SystemTableInfo Pointer to old system table information. **/ EFI_STATUS EFIAPI @@ -182,9 +182,9 @@ RestoreStdInStdOutStdErr ( parameters for inclusion in EFI_SHELL_PARAMETERS_PROTOCOL. this supports space delimited and quote surrounded parameter definition. - @param[in] CommandLine String of command line to parse - @param[in,out] Argv pointer to array of strings; one for each parameter - @param[in,out] Argc pointer to number of strings in Argv array + @param[in] CommandLine String of command line to parse + @param[in, out] Argv pointer to array of strings; one for each parameter + @param[in, out] Argc pointer to number of strings in Argv array @return EFI_SUCCESS the operation was sucessful @return EFI_OUT_OF_RESOURCES a memory allocation failed. @@ -207,9 +207,9 @@ ParseCommandLineToArgs( Temp Parameter must be large enough to hold the parameter before calling this function. - @param[in,out] Walker pointer to string of command line. Adjusted to + @param[in, out] Walker pointer to string of command line. Adjusted to reminaing command line on return - @param[in,out] TempParameter pointer to string of command line item extracted. + @param[in, out] TempParameter pointer to string of command line item extracted. **/ VOID diff --git a/ShellPkg/Application/Shell/ShellProtocol.c b/ShellPkg/Application/Shell/ShellProtocol.c index e42f081834..ee40e40f08 100644 --- a/ShellPkg/Application/Shell/ShellProtocol.c +++ b/ShellPkg/Application/Shell/ShellProtocol.c @@ -1945,8 +1945,8 @@ EfiShellFindFilesInDir( /** Updates a file name to be preceeded by the mapped drive name - @param[in] BasePath the Mapped drive name to prepend - @param[in,out] Path pointer to pointer to the file name to update. + @param[in] BasePath the Mapped drive name to prepend + @param[in, out] Path pointer to pointer to the file name to update. @retval EFI_SUCCESS @retval EFI_OUT_OF_RESOURCES @@ -2001,12 +2001,12 @@ UpdateFileName( Upon a EFI_SUCCESS return fromt he function any the caller is responsible to call FreeFileList with FileList. - @param[in] FilePattern The FilePattern to check against. - @param[in] UnicodeCollation The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure - @param[in] FileHandle The FileHandle to start with - @param[in,out] FileList pointer to pointer to list of found files. - @param[in] ParentNode The node for the parent. Same file as identified by HANDLE. - @param[in] MapName The file system name this file is on. + @param[in] FilePattern The FilePattern to check against. + @param[in] UnicodeCollation The pointer to EFI_UNICODE_COLLATION_PROTOCOL structure + @param[in] FileHandle The FileHandle to start with + @param[in, out] FileList pointer to pointer to list of found files. + @param[in] ParentNode The node for the parent. Same file as identified by HANDLE. + @param[in] MapName The file system name this file is on. @retval EFI_SUCCESS all files were found and the FileList contains a list. @retval EFI_NOT_FOUND no files were found @@ -3124,7 +3124,7 @@ EFI_SHELL_PROTOCOL mShellProtocol = { This must be removed via calling CleanUpShellProtocol(). - @param[in,out] NewShell The pointer to the pointer to the structure + @param[in, out] NewShell The pointer to the pointer to the structure to install. @retval EFI_SUCCESS The operation was successful. @@ -3253,7 +3253,7 @@ CreatePopulateInstallShellProtocol ( Free all memory and restore the system to the state it was in before calling CreatePopulateInstallShellProtocol. - @param[in,out] NewShell The pointer to the new shell protocol structure. + @param[in, out] NewShell The pointer to the new shell protocol structure. @retval EFI_SUCCESS The operation was successful. **/ diff --git a/ShellPkg/Application/Shell/ShellProtocol.h b/ShellPkg/Application/Shell/ShellProtocol.h index 1b809ecd29..a63ae8fc83 100644 --- a/ShellPkg/Application/Shell/ShellProtocol.h +++ b/ShellPkg/Application/Shell/ShellProtocol.h @@ -68,7 +68,7 @@ typedef struct { This must be removed via calling CleanUpShellProtocol(). - @param[in,out] NewShell The pointer to the pointer to the structure + @param[in, out] NewShell The pointer to the pointer to the structure to install. @retval EFI_SUCCESS The operation was successful. @@ -86,7 +86,7 @@ CreatePopulateInstallShellProtocol ( Free all memory and restore the system to the state it was in before calling CreatePopulateInstallShellProtocol. - @param[in,out] NewShell The pointer to the new shell protocol structure. + @param[in, out] NewShell The pointer to the new shell protocol structure. @retval EFI_SUCCESS The operation was successful. **/ diff --git a/ShellPkg/Application/ShellSortTestApp/ShellSortTestApp.c b/ShellPkg/Application/ShellSortTestApp/ShellSortTestApp.c index 91817ee291..d1a056898a 100644 --- a/ShellPkg/Application/ShellSortTestApp/ShellSortTestApp.c +++ b/ShellPkg/Application/ShellSortTestApp/ShellSortTestApp.c @@ -38,8 +38,8 @@ Test(CONST VOID*b1, CONST VOID*b2) The ShellCEntryLib library instance wrappers the actual UEFI application entry point and calls this ShellAppMain function. - @param ImageHandle The image handle of the UEFI Application. - @param SystemTable A pointer to the EFI System Table. + @param Argc Argument count + @param Argv The parsed arguments @retval 0 The application exited normally. @retval Other An error occurred. -- cgit v1.2.3