diff options
| author | ydong10 <ydong10@6f19259b-4bc3-4df7-8a09-765794883524> | 2011-09-02 08:05:34 +0000 |
|---|---|---|
| committer | ydong10 <ydong10@6f19259b-4bc3-4df7-8a09-765794883524> | 2011-09-02 08:05:34 +0000 |
| commit | 4ff7e37b4f7e336a8ecb7080b8f48eef4b52d396 (patch) | |
| tree | d82f18a696ce519ca87925ab809db196b6358334 /ShellPkg | |
| parent | 6709bbd17f09965f03fa34043923361a01ec13ed (diff) | |
| download | edk2-platforms-4ff7e37b4f7e336a8ecb7080b8f48eef4b52d396.tar.xz | |
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
Diffstat (limited to 'ShellPkg')
51 files changed, 500 insertions, 497 deletions
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.
diff --git a/ShellPkg/Include/Library/FileHandleLib.h b/ShellPkg/Include/Library/FileHandleLib.h index b4c2e7ddee..a21e20ed95 100644 --- a/ShellPkg/Include/Library/FileHandleLib.h +++ b/ShellPkg/Include/Library/FileHandleLib.h @@ -82,10 +82,10 @@ FileHandleSetInfo ( are no more directory entries, the read returns a zero-length buffer.
EFI_FILE_INFO is the structure returned as the directory entry.
- @param[in] FileHandle The opened file handle.
- @param[in,out] BufferSize On input, the size of buffer in bytes. On return,
- the number of bytes written.
- @param[out] Buffer The buffer to put read data into.
+ @param[in] FileHandle The opened file handle.
+ @param[in, out] BufferSize On input, the size of buffer in bytes. On return,
+ the number of bytes written.
+ @param[out] Buffer The buffer to put read data into.
@retval EFI_SUCCESS Data was read.
@retval EFI_NO_MEDIA The device has no media.
@@ -113,10 +113,10 @@ FileHandleRead( The file is automatically grown to hold the data if required. Direct writes to
opened directories are not supported.
- @param[in] FileHandle The opened file for writing.
- @param[in,out] BufferSize On input, the number of bytes in Buffer. On output,
- the number of bytes written.
- @param[in] Buffer The buffer containing data to write is stored.
+ @param[in] FileHandle The opened file for writing.
+ @param[in, out] BufferSize On input, the number of bytes in Buffer. On output,
+ the number of bytes written.
+ @param[in] Buffer The buffer containing data to write is stored.
@retval EFI_SUCCESS Data was written.
@retval EFI_UNSUPPORTED Writes to an open directory are not supported.
@@ -379,17 +379,17 @@ FileHandleGetFileName ( If the position upon start is 0, then the Ascii Boolean will be set. This should be
maintained and not changed for all operations with the same file.
- @param[in] Handle FileHandle to read from.
- @param[in,out] Buffer The pointer to buffer to read into.
- @param[in,out] Size The pointer to number of bytes in Buffer.
- @param[in] Truncate If the buffer is large enough, this has no effect.
- If the buffer is is too small and Truncate is TRUE,
- the line will be truncated.
- If the buffer is is too small and Truncate is FALSE,
- then no read will occur.
+ @param[in] Handle FileHandle to read from.
+ @param[in, out] Buffer The pointer to buffer to read into.
+ @param[in, out] Size The pointer to number of bytes in Buffer.
+ @param[in] Truncate If the buffer is large enough, this has no effect.
+ If the buffer is is too small and Truncate is TRUE,
+ the line will be truncated.
+ If the buffer is is too small and Truncate is FALSE,
+ then no read will occur.
- @param[in,out] Ascii Boolean value for indicating whether the file is
- Ascii (TRUE) or UCS2 (FALSE).
+ @param[in, out] Ascii Boolean value for indicating whether the file is
+ Ascii (TRUE) or UCS2 (FALSE).
@retval EFI_SUCCESS The operation was successful. The line is stored in
Buffer.
@@ -416,9 +416,9 @@ FileHandleReadLine( If the position upon start is 0, then the Ascii Boolean will be set. This should be
maintained and not changed for all operations with the same file.
- @param[in] Handle FileHandle to read from.
- @param[in,out] Ascii Boolean value for indicating whether the file is
- Ascii (TRUE) or UCS2 (FALSE).
+ @param[in] Handle FileHandle to read from.
+ @param[in, out] Ascii Boolean value for indicating whether the file is
+ Ascii (TRUE) or UCS2 (FALSE).
@return The line of text from the file.
diff --git a/ShellPkg/Include/Library/PathLib.h b/ShellPkg/Include/Library/PathLib.h index 912b1f14b0..ee473523d2 100644 --- a/ShellPkg/Include/Library/PathLib.h +++ b/ShellPkg/Include/Library/PathLib.h @@ -21,7 +21,7 @@ Removes the last directory or file entry in a path by changing the last
L'\' to a CHAR_NULL.
- @param[in,out] Path The pointer to the path to modify.
+ @param[in, out] Path The pointer to the path to modify.
@retval FALSE Nothing was found to remove.
@retval TRUE A directory or file was removed.
diff --git a/ShellPkg/Include/Library/ShellCommandLib.h b/ShellPkg/Include/Library/ShellCommandLib.h index 5bc03ce256..f453d22f3d 100644 --- a/ShellPkg/Include/Library/ShellCommandLib.h +++ b/ShellPkg/Include/Library/ShellCommandLib.h @@ -159,12 +159,12 @@ ShellCommandRegisterCommandName ( information is returned. If Sections is NULL, then all help text information
available is returned.
- @param[in] CommandString The pointer to the command name. This is the name
- found on the command line in the shell.
- @param[in,out] RetVal The pointer to the return value from the command handler.
+ @param[in] CommandString The pointer to the command name. This is the name
+ found on the command line in the shell.
+ @param[in, out] RetVal The pointer to the return value from the command handler.
- @param[in,out] CanAffectLE Indicates whether this command's return value
- needs to be placed into LASTERROR environment variable.
+ @param[in, out] CanAffectLE Indicates whether this command's return value
+ needs to be placed into LASTERROR environment variable.
@retval RETURN_SUCCESS The handler was run.
@retval RETURN_NOT_FOUND The CommandString did not match a registered
diff --git a/ShellPkg/Include/Library/ShellLib.h b/ShellPkg/Include/Library/ShellLib.h index 2ee8ae5428..5f3c5588bb 100644 --- a/ShellPkg/Include/Library/ShellLib.h +++ b/ShellPkg/Include/Library/ShellLib.h @@ -82,12 +82,12 @@ ShellSetFileInfo ( This function opens a file with the open mode according to the file path. The
Attributes is valid only for EFI_FILE_MODE_CREATE.
- @param[in,out] FilePath On input, the device path to the file. On output,
- the remaining device path.
- @param[out] DeviceHandle Pointer to the system device handle.
- @param[out] FileHandle Pointer to the file handle.
- @param[in] OpenMode The mode to open the file with.
- @param[in] Attributes The file's file attributes.
+ @param[in, out] FilePath On input, the device path to the file. On output,
+ the remaining device path.
+ @param[out] DeviceHandle Pointer to the system device handle.
+ @param[out] FileHandle Pointer to the file handle.
+ @param[in] OpenMode The mode to open the file with.
+ @param[in] Attributes The file's file attributes.
@retval EFI_SUCCESS The information was set.
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
@@ -204,10 +204,10 @@ ShellCreateDirectory( are no more directory entries, the read returns a zero-length buffer.
EFI_FILE_INFO is the structure returned as the directory entry.
- @param[in] FileHandle The opened file handle.
- @param[in,out] ReadSize On input the size of buffer in bytes. On return
- the number of bytes written.
- @param[out] Buffer The buffer to put read data into.
+ @param[in] FileHandle The opened file handle.
+ @param[in, out] ReadSize On input the size of buffer in bytes. On return
+ the number of bytes written.
+ @param[out] Buffer The buffer to put read data into.
@retval EFI_SUCCESS Data was read.
@retval EFI_NO_MEDIA The device has no media.
@@ -235,12 +235,12 @@ ShellReadFile( The file is automatically grown to hold the data if required. Direct writes to
opened directories are not supported.
- @param[in] FileHandle The opened file for writing.
+ @param[in] FileHandle The opened file for writing.
- @param[in,out] BufferSize On input the number of bytes in Buffer. On output
- the number of bytes written.
+ @param[in, out] BufferSize On input the number of bytes in Buffer. On output
+ the number of bytes written.
- @param[in] Buffer The buffer containing data to write is stored.
+ @param[in] Buffer The buffer containing data to write is stored.
@retval EFI_SUCCESS Data was written.
@retval EFI_UNSUPPORTED Writes to an open directory are not supported.
@@ -402,9 +402,9 @@ ShellFindFirstFile ( call of this function has no file to get. *NoFile will be set to TRUE, and the
data in Buffer is meaningless.
- @param[in] DirHandle The file handle of the directory.
- @param[in,out] Buffer The pointer to buffer for file's information.
- @param[in,out] NoFile The pointer to boolean when last file is found.
+ @param[in] DirHandle The file handle of the directory.
+ @param[in, out] Buffer The pointer to buffer for file's information.
+ @param[in, out] NoFile The pointer to boolean when last file is found.
@retval EFI_SUCCESS Found the next file.
@retval EFI_NO_MEDIA The device has no media.
@@ -583,9 +583,9 @@ ShellSetPageBreakMode ( If you are NOT appending to an existing list *ListHead must be NULL. If
*ListHead is NULL then it must be callee freed.
- @param[in] Arg The pointer to path string.
- @param[in] OpenMode Mode to open files with.
- @param[in,out] ListHead Head of linked list of results.
+ @param[in] Arg The pointer to path string.
+ @param[in] OpenMode Mode to open files with.
+ @param[in, out] ListHead Head of linked list of results.
@retval EFI_SUCCESS The operation was sucessful and the list head
contains the list of opened files.
@@ -604,7 +604,7 @@ ShellOpenFileMetaArg ( /**
Free the linked list returned from ShellOpenFileMetaArg.
- @param[in,out] ListHead The pointer to free.
+ @param[in, out] ListHead The pointer to free.
@retval EFI_SUCCESS The operation was sucessful.
@retval EFI_INVALID_PARAMETER A parameter was invalid.
@@ -1024,13 +1024,13 @@ ShellStrToUintn( If Destination's current length (including NULL terminator) is already more than
CurrentSize, then ASSERT().
- @param[in,out] Destination The String to append onto.
- @param[in,out] CurrentSize On call, the number of bytes in Destination. On
- return, possibly the new size (still in bytes). If NULL,
- then allocate whatever is needed.
- @param[in] Source The String to append from.
- @param[in] Count The maximum number of characters to append. If 0, then
- all are appended.
+ @param[in, out] Destination The String to append onto.
+ @param[in, out] CurrentSize On call, the number of bytes in Destination. On
+ return, possibly the new size (still in bytes). If NULL,
+ then allocate whatever is needed.
+ @param[in] Source The String to append from.
+ @param[in] Count The maximum number of characters to append. If 0, then
+ all are appended.
@return The Destination after appending the Source.
**/
@@ -1051,14 +1051,14 @@ StrnCatGrow ( If the string would grow bigger than NewSize it will halt and return error.
- @param[in] SourceString The string with source buffer.
- @param[in,out] NewString The string with resultant buffer.
- @param[in] NewSize The size in bytes of NewString.
- @param[in] FindTarget The string to look for.
- @param[in] ReplaceWith The string to replace FindTarget with.
- @param[in] SkipPreCarrot If TRUE will skip a FindTarget that has a '^'
- immediately before it.
- @param[in] ParameterReplacing If TRUE will add "" around items with spaces.
+ @param[in] SourceString The string with source buffer.
+ @param[in, out] NewString The string with resultant buffer.
+ @param[in] NewSize The size in bytes of NewString.
+ @param[in] FindTarget The string to look for.
+ @param[in] ReplaceWith The string to replace FindTarget with.
+ @param[in] SkipPreCarrot If TRUE will skip a FindTarget that has a '^'
+ immediately before it.
+ @param[in] ParameterReplacing If TRUE will add "" around items with spaces.
@retval EFI_INVALID_PARAMETER SourceString was NULL.
@retval EFI_INVALID_PARAMETER NewString was NULL.
@@ -1189,9 +1189,9 @@ ShellPromptForResponse ( @param[in] Type What type of question is asked. This is used to filter the input
to prevent invalid answers to question.
- @param[in] HiiFormatStringId The format string Id for getting from Hii.
- @param[in] HiiFormatHandle The format string Handle for getting from Hii.
- @param[in,out] Response The pointer to Response, which will be populated upon return.
+ @param[in] HiiFormatStringId The format string Id for getting from Hii.
+ @param[in] HiiFormatHandle The format string Handle for getting from Hii.
+ @param[in, out] Response The pointer to Response, which will be populated upon return.
@retval EFI_SUCCESS The operation was sucessful.
@return other The operation failed.
@@ -1273,11 +1273,11 @@ ShellFileExists( If the position upon start is 0, then the Ascii Boolean will be set. This should be
maintained and not changed for all operations with the same file.
- @param[in] Handle SHELL_FILE_HANDLE to read from.
- @param[in,out] Ascii Boolean value for indicating whether the file is
- Ascii (TRUE) or UCS2 (FALSE).
+ @param[in] Handle SHELL_FILE_HANDLE to read from.
+ @param[in, out] Ascii Boolean value for indicating whether the file is
+ Ascii (TRUE) or UCS2 (FALSE).
- @return The line of text from the file.
+ @return The line of text from the file.
@sa ShellFileHandleReadLine
**/
@@ -1294,17 +1294,17 @@ ShellFileHandleReturnLine( If the position upon start is 0, then the Ascii Boolean will be set. This should be
maintained and not changed for all operations with the same file.
- @param[in] Handle SHELL_FILE_HANDLE to read from.
- @param[in,out] Buffer The pointer to buffer to read into.
- @param[in,out] Size The pointer to number of bytes in Buffer.
- @param[in] Truncate If the buffer is large enough, this has no effect.
- If the buffer is is too small and Truncate is TRUE,
- the line will be truncated.
- If the buffer is is too small and Truncate is FALSE,
- then no read will occur.
-
- @param[in,out] Ascii Boolean value for indicating whether the file is
- Ascii (TRUE) or UCS2 (FALSE).
+ @param[in] Handle SHELL_FILE_HANDLE to read from.
+ @param[in, out] Buffer The pointer to buffer to read into.
+ @param[in, out] Size The pointer to number of bytes in Buffer.
+ @param[in] Truncate If the buffer is large enough, this has no effect.
+ If the buffer is is too small and Truncate is TRUE,
+ the line will be truncated.
+ If the buffer is is too small and Truncate is FALSE,
+ then no read will occur.
+
+ @param[in, out] Ascii Boolean value for indicating whether the file is
+ Ascii (TRUE) or UCS2 (FALSE).
@retval EFI_SUCCESS The operation was successful. The line is stored in
Buffer.
diff --git a/ShellPkg/Include/Library/SortLib.h b/ShellPkg/Include/Library/SortLib.h index 9d6be6283b..a3e0fd9bec 100644 --- a/ShellPkg/Include/Library/SortLib.h +++ b/ShellPkg/Include/Library/SortLib.h @@ -43,12 +43,12 @@ INTN If Count is < 2 , then perform no action.
If Size is < 1 , then perform no action.
- @param[in,out] BufferToSort On call, a Buffer of (possibly sorted) elements;
- on return, a buffer of sorted elements.
- @param[in] Count The number of elements in the buffer to sort.
- @param[in] ElementSize The size of an element in bytes.
- @param[in] CompareFunction The function to call to perform the comparison
- of any two elements.
+ @param[in, out] BufferToSort On call, a Buffer of (possibly sorted) elements;
+ on return, a buffer of sorted elements.
+ @param[in] Count The number of elements in the buffer to sort.
+ @param[in] ElementSize The size of an element in bytes.
+ @param[in] CompareFunction The function to call to perform the comparison
+ of any two elements.
**/
VOID
EFIAPI
diff --git a/ShellPkg/Include/Protocol/EfiShell.h b/ShellPkg/Include/Protocol/EfiShell.h index 64483c01c2..d36c1f6b17 100644 --- a/ShellPkg/Include/Protocol/EfiShell.h +++ b/ShellPkg/Include/Protocol/EfiShell.h @@ -531,9 +531,9 @@ EFI_STATUS If there are multiple map names they will be semi-colon seperated in the
NULL-terminated string.
- @param[in,out] DevicePath On entry, points to a device path pointer. On
- exit, updates the pointer to point to the
- portion of the device path after the mapping.
+ @param[in, out] DevicePath On entry, points to a device path pointer. On
+ exit, updates the pointer to point to the
+ portion of the device path after the mapping.
@retval NULL No mapping was found.
@retval !=NULL Pointer to NULL-terminated mapping. The buffer
@@ -640,10 +640,10 @@ EFI_STATUS according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each
matching file has an EFI_SHELL_FILE_INFO structure created in a linked list.
- @param[in] Path A pointer to the path string.
- @param[in] OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or
- EFI_FILE_MODE_WRITE.
- @param[in,out] FileList Points to the start of a list of files opened.
+ @param[in] Path A pointer to the path string.
+ @param[in] OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or
+ EFI_FILE_MODE_WRITE.
+ @param[in, out] FileList Points to the start of a list of files opened.
@retval EFI_SUCCESS Create the file list successfully.
@return Can't create the file list.
@@ -710,9 +710,9 @@ EFI_STATUS current position is increased by the number of bytes returned.
If FileHandle is a directory, then an error is returned.
- @param[in] FileHandle The opened file handle for read.
- @param[in] ReadSize On input, the size of Buffer, in bytes. On output, the amount of data read.
- @param[in,out] Buffer The buffer in which data is read.
+ @param[in] FileHandle The opened file handle for read.
+ @param[in] ReadSize On input, the size of Buffer, in bytes. On output, the amount of data read.
+ @param[in, out] Buffer The buffer in which data is read.
@retval EFI_SUCCESS Data was read.
@retval EFI_NO_MEDIA The device has no media.
@@ -929,9 +929,9 @@ EFI_STATUS Direct writes to opened directories are not supported.
- @param[in] FileHandle The opened file handle for writing.
- @param[in,out] BufferSize On input, size of Buffer.
- @param[in] Buffer The buffer in which data to write.
+ @param[in] FileHandle The opened file handle for writing.
+ @param[in, out] BufferSize On input, size of Buffer.
+ @param[in] Buffer The buffer in which data to write.
@retval EFI_SUCCESS Data was written.
@retval EFI_UNSUPPORTED Writes to open directory are not supported.
diff --git a/ShellPkg/Include/Protocol/EfiShellEnvironment2.h b/ShellPkg/Include/Protocol/EfiShellEnvironment2.h index ad0b551b96..05ec69d5ac 100644 --- a/ShellPkg/Include/Protocol/EfiShellEnvironment2.h +++ b/ShellPkg/Include/Protocol/EfiShellEnvironment2.h @@ -61,7 +61,7 @@ EFI_STATUS This is used when programatically adding shell commands. Upon successful return
the memory allocated is up to the caller to free.
- @param[in,out] Str Pointer to pointer to string to display for help.
+ @param[in, out] Str Pointer to pointer to string to display for help.
@retval EFI_SUCCESS The help string is in the parameter Str.
@@ -270,9 +270,9 @@ CHAR16* The memory allocated by the callee for this list is freed by making a call to
SHELLENV_FREE_FILE_LIST.
- @param[in] Arg The pointer Path to files to open.
- @param[in,out] ListHead The pointer to the allocated and initialized list head
- upon which to append all opened file structures.
+ @param[in] Arg The pointer Path to files to open.
+ @param[in, out] ListHead The pointer to the allocated and initialized list head
+ upon which to append all opened file structures.
@retval EFI_SUCCESS One or more files was opened and a struct of each file's
information was appended to ListHead.
@@ -289,7 +289,7 @@ EFI_STATUS /**
This frees all of the nodes under the ListHead, but not ListHead itself.
- @param[in,out] ListHead Pointer to list to free all nodes of.
+ @param[in, out] ListHead Pointer to list to free all nodes of.
@retval EFI_SUCCESS This function always returns EFI_SUCCESS.
**/
@@ -473,12 +473,12 @@ BOOLEAN This is an internal shell function to handle shell cascading. It restores the
original set of console protocols.
- @param[in] ConInHandle The handle of ConIn.
- @param[in,out] ConIn The pointer to the location to return the pointer to
- the original console input.
- @param[in] ConOutHandle The handle of ConOut
- @param[in,out] ConOut The pointer to the location to return the pointer to
- the original console output.
+ @param[in] ConInHandle The handle of ConIn.
+ @param[in, out] ConIn The pointer to the location to return the pointer to
+ the original console input.
+ @param[in] ConOutHandle The handle of ConOut
+ @param[in, out] ConOut The pointer to the location to return the pointer to
+ the original console output.
**/
typedef
VOID
@@ -512,8 +512,8 @@ VOID This must be called after INIT_HANDLE_ENUMERATOR and before CLOSE_HANDLE_ENUMERATOR.
- @param[in,out] Handle The pointer to pointer to Handle. It is set
- on a sucessful return.
+ @param[in, out] Handle The pointer to pointer to Handle. It is set
+ on a sucessful return.
@retval EFI_SUCCESS The next handle in the handle database is *Handle.
@retval EFI_NOT_FOUND There is not another handle.
@@ -656,7 +656,7 @@ VOID This cannot be called after CLOSE_PROTOCOL_INFO_ENUMERATOR, but it must be
called after INIT_PROTOCOL_INFO_ENUMERATOR.
- @param[in,out] ProtocolInfo The pointer to pointer to protocol information structure.
+ @param[in, out] ProtocolInfo The pointer to pointer to protocol information structure.
@retval EFI_SUCCESS The next protocol's information was sucessfully returned.
@retval NULL There are no more protocols.
@@ -744,15 +744,15 @@ typedef struct { Upon successful return, the memory for *BestDeviceName is up to the caller to free.
- @param[in] DeviceHandle The device handle whose name is desired.
- @param[in] UseComponentName Whether to use the ComponentName protocol at all.
- @param[in] UseDevicePath Whether to use the DevicePath protocol at all.
- @param[in] Language The pointer to the language string to use.
- @param[in,out] BestDeviceName The pointer to pointer to string allocated with the name.
- @param[out] ConfigurationStatus The pointer to status for opening a Configuration protocol.
- @param[out] DiagnosticsStatus The pointer to status for opening a Diagnostics protocol.
- @param[in] Display Whether to Print this out to default Print location.
- @param[in] Indent How many characters to indent the printing.
+ @param[in] DeviceHandle The device handle whose name is desired.
+ @param[in] UseComponentName Whether to use the ComponentName protocol at all.
+ @param[in] UseDevicePath Whether to use the DevicePath protocol at all.
+ @param[in] Language The pointer to the language string to use.
+ @param[in, out] BestDeviceName The pointer to pointer to string allocated with the name.
+ @param[out] ConfigurationStatus The pointer to status for opening a Configuration protocol.
+ @param[out] DiagnosticsStatus The pointer to status for opening a Diagnostics protocol.
+ @param[in] Display Whether to Print this out to default Print location.
+ @param[in] Indent How many characters to indent the printing.
@retval EFI_SUCCESS This function always returns EFI_SUCCESS.
**/
@@ -849,9 +849,9 @@ EFI_STATUS The memory allocated by the callee for this list is freed by making a call to
SHELLENV_FREE_FILE_LIST.
- @param[in] Arg The pointer to the path of the files to be opened.
- @param[in,out] ListHead The pointer to allocated and initialized list head
- upon which to append all the opened file structures.
+ @param[in] Arg The pointer to the path of the files to be opened.
+ @param[in, out] ListHead The pointer to allocated and initialized list head
+ upon which to append all the opened file structures.
@retval EFI_SUCCESS One or more files was opened and a struct of each file's
information was appended to ListHead.
diff --git a/ShellPkg/Library/BasePathLib/BasePathLib.c b/ShellPkg/Library/BasePathLib/BasePathLib.c index b0d4bf34c2..77d5866a81 100644 --- a/ShellPkg/Library/BasePathLib/BasePathLib.c +++ b/ShellPkg/Library/BasePathLib/BasePathLib.c @@ -20,7 +20,7 @@ Removes the last directory or file entry in a path by changing the last
L'\' to a CHAR_NULL.
- @param[in,out] Path The pointer to the path to modify.
+ @param[in, out] Path The pointer to the path to modify.
@retval FALSE Nothing was found to remove.
@retval TRUE A directory or file was removed.
diff --git a/ShellPkg/Library/BaseSortLib/BaseSortLib.c b/ShellPkg/Library/BaseSortLib/BaseSortLib.c index 2a3058d3ca..0b7e8f3f6f 100644 --- a/ShellPkg/Library/BaseSortLib/BaseSortLib.c +++ b/ShellPkg/Library/BaseSortLib/BaseSortLib.c @@ -34,13 +34,13 @@ if Count is < 2 then perform no action.
if Size is < 1 then perform no action.
- @param[in,out] BufferToSort on call a Buffer of (possibly sorted) elements
- on return a buffer of sorted elements
- @param[in] Count the number of elements in the buffer to sort
- @param[in] ElementSize Size of an element in bytes
- @param[in] CompareFunction The function to call to perform the comparison
- of any 2 elements
- @param[in] Buffer Buffer of size ElementSize for use in swapping
+ @param[in, out] BufferToSort on call a Buffer of (possibly sorted) elements
+ on return a buffer of sorted elements
+ @param[in] Count the number of elements in the buffer to sort
+ @param[in] ElementSize Size of an element in bytes
+ @param[in] CompareFunction The function to call to perform the comparison
+ of any 2 elements
+ @param[in] Buffer Buffer of size ElementSize for use in swapping
**/
VOID
EFIAPI
@@ -139,12 +139,12 @@ QuickSortWorker ( if Count is < 2 then perform no action.
if Size is < 1 then perform no action.
- @param[in,out] BufferToSort on call a Buffer of (possibly sorted) elements
- on return a buffer of sorted elements
- @param[in] Count the number of elements in the buffer to sort
- @param[in] ElementSize Size of an element in bytes
- @param[in] CompareFunction The function to call to perform the comparison
- of any 2 elements
+ @param[in, out] BufferToSort on call a Buffer of (possibly sorted) elements
+ on return a buffer of sorted elements
+ @param[in] Count the number of elements in the buffer to sort
+ @param[in] ElementSize Size of an element in bytes
+ @param[in] CompareFunction The function to call to perform the comparison
+ of any 2 elements
**/
VOID
EFIAPI
diff --git a/ShellPkg/Library/UefiFileHandleLib/UefiFileHandleLib.c b/ShellPkg/Library/UefiFileHandleLib/UefiFileHandleLib.c index fd8b7bbaec..a4820c9970 100644 --- a/ShellPkg/Library/UefiFileHandleLib/UefiFileHandleLib.c +++ b/ShellPkg/Library/UefiFileHandleLib/UefiFileHandleLib.c @@ -698,8 +698,8 @@ FileHandleSetSize ( if Destination's current length (including NULL terminator) is already more then
CurrentSize, then ASSERT()
- @param[in,out] Destination The String to append onto
- @param[in,out] CurrentSize on call the number of bytes in Destination. On
+ @param[in, out] Destination The String to append onto
+ @param[in, out] CurrentSize on call the number of bytes in Destination. On
return possibly the new size (still in bytes). if NULL
then allocate whatever is needed.
@param[in] Source The String to append from
@@ -879,8 +879,8 @@ FileHandleGetFileName ( If the position upon start is 0, then the Ascii Boolean will be set. This should be
maintained and not changed for all operations with the same file.
- @param[in] Handle FileHandle to read from.
- @param[in,out] Ascii Boolean value for indicating whether the file is Ascii (TRUE) or UCS2 (FALSE);
+ @param[in] Handle FileHandle to read from.
+ @param[in, out] Ascii Boolean value for indicating whether the file is Ascii (TRUE) or UCS2 (FALSE);
@return The line of text from the file.
@@ -919,13 +919,13 @@ FileHandleReturnLine( If the position upon start is 0, then the Ascii Boolean will be set. This should be
maintained and not changed for all operations with the same file.
- @param[in] Handle FileHandle to read from
- @param[in,out] Buffer pointer to buffer to read into
- @param[in,out] Size pointer to number of bytes in buffer
- @param[in] Truncate if TRUE then allows for truncation of the line to fit.
- if FALSE will reset the position to the begining of the
- line if the buffer is not large enough.
- @param[in,out] Ascii Boolean value for indicating whether the file is Ascii (TRUE) or UCS2 (FALSE);
+ @param[in] Handle FileHandle to read from
+ @param[in, out] Buffer pointer to buffer to read into
+ @param[in, out] Size pointer to number of bytes in buffer
+ @param[in] Truncate if TRUE then allows for truncation of the line to fit.
+ if FALSE will reset the position to the begining of the
+ line if the buffer is not large enough.
+ @param[in, out] Ascii Boolean value for indicating whether the file is Ascii (TRUE) or UCS2 (FALSE);
@retval EFI_SUCCESS the operation was sucessful. the line is stored in
Buffer.
diff --git a/ShellPkg/Library/UefiHandleParsingLib/UefiHandleParsingLib.c b/ShellPkg/Library/UefiHandleParsingLib/UefiHandleParsingLib.c index eb1dbbd3fd..131c077b1e 100644 --- a/ShellPkg/Library/UefiHandleParsingLib/UefiHandleParsingLib.c +++ b/ShellPkg/Library/UefiHandleParsingLib/UefiHandleParsingLib.c @@ -1179,10 +1179,10 @@ ParseHandleDatabaseForChildControllers( If DestinationBuffer is NULL, then ASSERT().
- @param[in,out] DestinationBuffer The pointer to the pointer to the buffer to append onto.
- @param[in,out] DestinationSize The pointer to the size of DestinationBuffer.
- @param[in] SourceBuffer The pointer to the buffer to append onto DestinationBuffer.
- @param[in] SourceSize The number of bytes of SourceBuffer to append.
+ @param[in, out] DestinationBuffer The pointer to the pointer to the buffer to append onto.
+ @param[in, out] DestinationSize The pointer to the size of DestinationBuffer.
+ @param[in] SourceBuffer The pointer to the buffer to append onto DestinationBuffer.
+ @param[in] SourceSize The number of bytes of SourceBuffer to append.
@retval NULL A memory allocation failed.
@retval NULL A parameter was invalid.
diff --git a/ShellPkg/Library/UefiShellCommandLib/ConsistMapping.c b/ShellPkg/Library/UefiShellCommandLib/ConsistMapping.c index fc9b906ffd..9fbcbb3eb2 100644 --- a/ShellPkg/Library/UefiShellCommandLib/ConsistMapping.c +++ b/ShellPkg/Library/UefiShellCommandLib/ConsistMapping.c @@ -131,8 +131,8 @@ MTD_NAME mMTDName[] = { /**
Function to append a 64 bit number / 25 onto the string.
- @param[in,out] Str The string so append onto.
- @param[in] Num The number to divide and append.
+ @param[in, out] Str The string so append onto.
+ @param[in] Num The number to divide and append.
@retval EFI_INVALID_PARAMETER A parameter was NULL.
@retval EFI_SUCCESS The appending was successful.
@@ -163,8 +163,8 @@ AppendCSDNum2 ( /**
Function to append a 64 bit number onto the mapping info.
- @param[in,out] MappingItem The mapping info object to append onto.
- @param[in] Num The info to append.
+ @param[in, out] MappingItem The mapping info object to append onto.
+ @param[in] Num The info to append.
@retval EFI_INVALID_PARAMETER A parameter was NULL.
@retval EFI_SUCCESS The appending was successful.
@@ -194,8 +194,8 @@ AppendCSDNum ( /**
Function to append string into the mapping info.
- @param[in,out] MappingItem The mapping info object to append onto.
- @param[in] Str The info to append.
+ @param[in, out] MappingItem The mapping info object to append onto.
+ @param[in] Str The info to append.
@retval EFI_INVALID_PARAMETER A parameter was NULL.
@retval EFI_SUCCESS The appending was successful.
@@ -281,8 +281,8 @@ AppendCSDStr ( /**
Function to append a Guid to the mapping item.
- @param[in,out] MappingItem The item to append onto.
- @param[in] Guid The guid to append.
+ @param[in, out] MappingItem The item to append onto.
+ @param[in] Guid The guid to append.
@retval EFI_SUCCESS The appending operation was successful.
@retval EFI_INVALID_PARAMETER A parameter was NULL.
diff --git a/ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.c b/ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.c index cb452d44d5..2c1dcd3c13 100644 --- a/ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.c +++ b/ShellPkg/Library/UefiShellCommandLib/UefiShellCommandLib.c @@ -424,12 +424,12 @@ ShellCommandGetProfileList ( information will be returned. If Sections is NULL, then all help text information
available will be returned.
- @param[in] CommandString Pointer to the command name. This is the name
- found on the command line in the shell.
- @param[in,out] RetVal Pointer to the return vaule from the command handler.
+ @param[in] CommandString Pointer to the command name. This is the name
+ found on the command line in the shell.
+ @param[in, out] RetVal Pointer to the return vaule from the command handler.
- @param[in,out] CanAffectLE indicates whether this command's return value
- needs to be placed into LASTERROR environment variable.
+ @param[in, out] CanAffectLE indicates whether this command's return value
+ needs to be placed into LASTERROR environment variable.
@retval RETURN_SUCCESS The handler was run.
@retval RETURN_NOT_FOUND The CommandString did not match a registered
diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/Bcfg.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/Bcfg.c index 24926a8e9a..de2ce2bfc3 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/Bcfg.c +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/Bcfg.c @@ -49,8 +49,9 @@ typedef struct { /**
This function will populate the device path protocol parameter based on TheHandle.
-
- @param[in,out] DevPath On a sucessful return the device path to the handle.
+
+ @param[in] TheHandle Driver handle.
+ @param[in, out] FilePath On a sucessful return the device path to the handle.
@retval EFI_SUCCESS The device path was sucessfully returned.
@retval other A error from gBS->HandleProtocol.
diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.c index 01321d1ed6..06a3210ea0 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.c +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.c @@ -1324,10 +1324,10 @@ Encode ( /**
The compression routine.
- @param[in] SrcBuffer The buffer containing the source data.
- @param[in] SrcSize The number of bytes in SrcBuffer.
- @param[in] DstBuffer The buffer to put the compressed image in.
- @param[in,out] DstSize On input the size (in bytes) of DstBuffer, on
+ @param[in] SrcBuffer The buffer containing the source data.
+ @param[in] SrcSize The number of bytes in SrcBuffer.
+ @param[in] DstBuffer The buffer to put the compressed image in.
+ @param[in, out] DstSize On input the size (in bytes) of DstBuffer, on
return the number of bytes placed in DstBuffer.
@retval EFI_SUCCESS The compression was sucessful.
diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.h b/ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.h index 64e339cf97..39a997178f 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.h +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.h @@ -18,11 +18,11 @@ /**
The compression routine.
- @param[in] SrcBuffer The buffer containing the source data.
- @param[in] SrcSize Number of bytes in SrcBuffer.
- @param[in] DstBuffer The buffer to put the compressed image in.
- @param[in,out] DstSize On input the size (in bytes) of DstBuffer, on
- return the number of bytes placed in DstBuffer.
+ @param[in] SrcBuffer The buffer containing the source data.
+ @param[in] SrcSize Number of bytes in SrcBuffer.
+ @param[in] DstBuffer The buffer to put the compressed image in.
+ @param[in, out] DstSize On input the size (in bytes) of DstBuffer, on
+ return the number of bytes placed in DstBuffer.
@retval EFI_SUCCESS The compression was sucessful.
@retval EFI_BUFFER_TOO_SMALL The buffer was too small. DstSize is required.
diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/Edit/FileBuffer.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/Edit/FileBuffer.c index ba622983e1..7d82884326 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/Edit/FileBuffer.c +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/Edit/FileBuffer.c @@ -1685,8 +1685,8 @@ FileBufferScrollLeft ( /**
Delete a char in line
- @param[in,out] Line The line to delete in.
- @param[in] Pos Position to delete the char at ( start from 0 ).
+ @param[in, out] Line The line to delete in.
+ @param[in] Pos Position to delete the char at ( start from 0 ).
**/
VOID
EFIAPI
@@ -1710,8 +1710,8 @@ LineDeleteAt ( /**
Concatenate Src into Dest.
- @param[in,out] Dest Destination string
- @param[in] Src Src String.
+ @param[in, out] Dest Destination string
+ @param[in] Src Src String.
**/
VOID
EFIAPI
@@ -2981,7 +2981,7 @@ FileBufferSearch ( //
// found
//
- if (Found == TRUE) {
+ if (Found) {
Column = (Position - 1) + FileBuffer.FilePosition.Column + Offset;
Row = FileBuffer.FilePosition.Row;
} else {
@@ -3000,7 +3000,7 @@ FileBufferSearch ( Found = TRUE;
}
- if (Found == TRUE) {
+ if (Found) {
//
// found
//
diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MainHexEditor.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MainHexEditor.c index 3602a72433..808f7a56c0 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MainHexEditor.c +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MainHexEditor.c @@ -106,10 +106,11 @@ HMainCommandDisplayHelp ( VOID
)
{
- INT32 CurrentLine=0;
+ INT32 CurrentLine;
CHAR16 * InfoString;
EFI_INPUT_KEY Key;
-
+
+ CurrentLine = 0;
// print helpInfo
for (CurrentLine = 0; 0 != HexMainMenuHelpInfo[CurrentLine]; CurrentLine++) {
InfoString = HiiGetString(gShellDebug1HiiHandle, HexMainMenuHelpInfo[CurrentLine]
diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MemImage.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MemImage.c index f327c5aede..9d44abddd7 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MemImage.c +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MemImage.c @@ -41,11 +41,11 @@ HEFI_EDITOR_MEM_IMAGE HMemImageConst = { /**
Empty function. always returns the same.
- @param[in] This Ignored.
- @param[in] Width Ignored.
- @param[in] Address Ignored.
- @param[in] Count Ignored.
- @param[in,out] Buffer Ignored.
+ @param[in] This Ignored.
+ @param[in] Width Ignored.
+ @param[in] Address Ignored.
+ @param[in] Count Ignored.
+ @param[in, out] Buffer Ignored.
@retval EFI_UNSUPPORTED.
**/
@@ -65,11 +65,11 @@ DummyMemRead ( /**
Empty function. always returns the same.
- @param[in] This Ignored.
- @param[in] Width Ignored.
- @param[in] Address Ignored.
- @param[in] Count Ignored.
- @param[in,out] Buffer Ignored.
+ @param[in] This Ignored.
+ @param[in] Width Ignored.
+ @param[in] Address Ignored.
+ @param[in] Count Ignored.
+ @param[in, out] Buffer Ignored.
@retval EFI_UNSUPPORTED.
**/
diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/Pci.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/Pci.c index 3f4147f9a1..e597bbc6b0 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/Pci.c +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/Pci.c @@ -1268,7 +1268,7 @@ PCI_CLASS_ENTRY PCIPIFClass_0e00[] = { bits 23:16 - Base Class Code
bits 15:8 - Sub-Class Code
bits 7:0 - Programming Interface
- @param[in,out] ClassStrings Pointer of PCI_CLASS_STRINGS structure, which contains
+ @param[in, out] ClassStrings Pointer of PCI_CLASS_STRINGS structure, which contains
printable class strings corresponding to ClassCode. The
caller must not modify the strings that are pointed by
the fields in ClassStrings.
@@ -1474,11 +1474,11 @@ PciGetProtocolAndResource ( It also moves the pointer backward a node, to get prepared to be called
again.
- @param[in,out] Descriptors Points to current position of a serial of address space
- descriptors.
- @param[out] MinBus The lower range of bus number.
- @param[out] ManBus The upper range of bus number.
- @param[out] IsEnd Meet end of the serial of descriptors.
+ @param[in, out] Descriptors Points to current position of a serial of address space
+ descriptors.
+ @param[out] MinBus The lower range of bus number.
+ @param[out] MaxBus The upper range of bus number.
+ @param[out] IsEnd Meet end of the serial of descriptors.
@retval EFI_SUCCESS The command completed successfully.
**/
@@ -1543,11 +1543,11 @@ PciExplainBridgeData ( /**
Explain the Base Address Register(Bar) in PCI configuration space.
- @param[in] Bar Points to the Base Address Register intended to interpret.
- @param[in] Command Points to the register Command.
- @param[in] Address Address used to access configuration space of this PCI device.
- @param[in] IoDev Handle used to access configuration space of PCI device.
- @param[in,out] Index The Index.
+ @param[in] Bar Points to the Base Address Register intended to interpret.
+ @param[in] Command Points to the register Command.
+ @param[in] Address Address used to access configuration space of this PCI device.
+ @param[in] IoDev Handle used to access configuration space of PCI device.
+ @param[in, out] Index The Index.
@retval EFI_SUCCESS The command completed successfully.
**/
@@ -2564,11 +2564,11 @@ PciGetProtocolAndResource ( It also moves the pointer backward a node, to get prepared to be called
again.
- @param[in,out] Descriptors Points to current position of a serial of address space
- descriptors.
- @param[out] MinBus The lower range of bus number.
- @param[out] ManBus The upper range of bus number.
- @param[out] IsEnd Meet end of the serial of descriptors.
+ @param[in, out] Descriptors Points to current position of a serial of address space
+ descriptors.
+ @param[out] MinBus The lower range of bus number.
+ @param[out] MaxBus The upper range of bus number.
+ @param[out] IsEnd Meet end of the serial of descriptors.
@retval EFI_SUCCESS The command completed successfully.
**/
@@ -3148,11 +3148,11 @@ PciExplainBridgeData ( /**
Explain the Base Address Register(Bar) in PCI configuration space.
- @param[in] Bar Points to the Base Address Register intended to interpret.
- @param[in] Command Points to the register Command.
- @param[in] Address Address used to access configuration space of this PCI device.
- @param[in] IoDev Handle used to access configuration space of PCI device.
- @param[in,out] Index The Index.
+ @param[in] Bar Points to the Base Address Register intended to interpret.
+ @param[in] Command Points to the register Command.
+ @param[in] Address Address used to access configuration space of this PCI device.
+ @param[in] IoDev Handle used to access configuration space of PCI device.
+ @param[in, out] Index The Index.
@retval EFI_SUCCESS The command completed successfully.
**/
diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.c index 9e995683d0..ed73a584bd 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.c +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.c @@ -104,10 +104,10 @@ LibSmbiosGetEPS ( Handle is changed to the next handle or 0xFFFF when the end is
reached or the handle is not found.
- @param[in,out] Handle 0xFFFF: get the first structure
- Others: get a structure according to this value.
- @param[in,out] Buffer The pointer to the caller's memory buffer.
- @param[out] Length Length of return buffer in bytes.
+ @param[in, out] Handle 0xFFFF: get the first structure
+ Others: get a structure according to this value.
+ @param[in, out] Buffer The pointer to the caller's memory buffer.
+ @param[out] Length Length of return buffer in bytes.
@retval DMI_SUCCESS Buffer contains the required structure data
Handle is updated with next structure handle or
diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.h b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.h index 76442cdf1a..5a9b2ad626 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.h +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.h @@ -72,10 +72,10 @@ LibSmbiosGetEPS ( Handle is changed to the next handle or 0xFFFF when the end is
reached or the handle is not found.
- @param[in,out] Handle 0xFFFF: get the first structure
- Others: get a structure according to this value.
- @param[in,out] Buffer The pointer to the caller's memory buffer.
- @param[out] Length Length of return buffer in bytes.
+ @param[in, out] Handle 0xFFFF: get the first structure
+ Others: get a structure according to this value.
+ @param[in, out] Buffer The pointer to the caller's memory buffer.
+ @param[out] Length Length of return buffer in bytes.
@retval DMI_SUCCESS Buffer contains the required structure data
Handle is updated with next structure handle or
diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/PrintInfo.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/PrintInfo.c index 7a7caac456..7c081bdf8a 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/PrintInfo.c +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/PrintInfo.c @@ -82,9 +82,9 @@ Copy Length of Src buffer to Dest buffer,
add a NULL termination to Dest buffer.
- @param[in,out] Dest Destination buffer head.
- @param[in] Src Source buffer head.
- @param[in] Length Length of buffer to be copied.
+ @param[in, out] Dest Destination buffer head.
+ @param[in] Src Source buffer head.
+ @param[in] Length Length of buffer to be copied.
**/
VOID
MemToString (
diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.c index d84ab10c29..64997284b0 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.c +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.c @@ -2936,11 +2936,11 @@ TABLE_ITEM StructureTypeInfoTable[] = { Then all the Key Value between Low and High gets the same string
L"Unused".
- @param[in] Table The begin address of table.
- @param[in] Number The number of table items.
- @param[in] Key The query Key.
- @param[in,out] Info Input as empty buffer; output as data buffer.
- @param[in] InfoLen The max number of characters for Info.
+ @param[in] Table The begin address of table.
+ @param[in] Number The number of table items.
+ @param[in] Key The query Key.
+ @param[in, out] Info Input as empty buffer; output as data buffer.
+ @param[in] InfoLen The max number of characters for Info.
@return the found Key and Info is valid.
@retval QUERY_TABLE_UNFOUND and Info should be NULL.
diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.h b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.h index 6809820232..5a0c5e05c0 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.h +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.h @@ -52,11 +52,11 @@ typedef struct TABLE_ITEM { Then all the Key Value between Low and High gets the same string
L"Unused".
- @param[in] Table The begin address of table.
- @param[in] Number The number of table items.
- @param[in] Key The query Key.
- @param[in,out] Info Input as empty buffer; output as data buffer.
- @param[in] InfoLen The max number of characters for Info.
+ @param[in] Table The begin address of table.
+ @param[in] Number The number of table items.
+ @param[in] Key The query Key.
+ @param[in, out] Info Input as empty buffer; output as data buffer.
+ @param[in] InfoLen The max number of characters for Info.
@return the found Key and Info is valid.
@retval QUERY_TABLE_UNFOUND and Info should be NULL.
diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.c index f3cc8d9ce9..b54d8e1f28 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.c +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.c @@ -226,8 +226,8 @@ CharToUpper ( Function returns a system configuration table that is stored in the
EFI System Table based on the provided GUID.
- @param[in] TableGuid A pointer to the table's GUID type.
- @param[in,out] Table On exit, a pointer to a system configuration table.
+ @param[in] TableGuid A pointer to the table's GUID type.
+ @param[in, out] Table On exit, a pointer to a system configuration table.
@retval EFI_SUCCESS A configuration table matching TableGuid was found.
@retval EFI_NOT_FOUND A configuration table matching TableGuid was not found.
@@ -281,8 +281,8 @@ HexCharToUintn ( /**
Convert a string representation of a guid to a Guid value.
- @param[in] StringGuid The pointer to the string of a guid.
- @param[in,out] Guid The pointer to the GUID structure to populate.
+ @param[in] StringGuid The pointer to the string of a guid.
+ @param[in, out] Guid The pointer to the GUID structure to populate.
@retval EFI_INVALID_PARAMETER A parameter was invalid.
@retval EFI_SUCCESS The conversion was successful.
diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.h b/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.h index 3db03c8fab..7cabfe3278 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.h +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.h @@ -82,8 +82,8 @@ DumpHex ( Function returns a system configuration table that is stored in the
EFI System Table based on the provided GUID.
- @param[in] TableGuid A pointer to the table's GUID type.
- @param[in,out] Table On exit, a pointer to a system configuration table.
+ @param[in] TableGuid A pointer to the table's GUID type.
+ @param[in, out] Table On exit, a pointer to a system configuration table.
@retval EFI_SUCCESS A configuration table matching TableGuid was found.
@retval EFI_NOT_FOUND A configuration table matching TableGuid was not found.
@@ -98,8 +98,8 @@ GetSystemConfigurationTable ( /**
Convert a string representation of a GUID to the GUID value.
- @param[in] StringGuid The pointer to the string containing a GUID printed.
- @param[in,out] Guid The pointer to the buffer to get the GUID value.
+ @param[in] StringGuid The pointer to the string containing a GUID printed.
+ @param[in, out] Guid The pointer to the buffer to get the GUID value.
**/
EFI_STATUS
EFIAPI
diff --git a/ShellPkg/Library/UefiShellDriver1CommandsLib/Devices.c b/ShellPkg/Library/UefiShellDriver1CommandsLib/Devices.c index a6e27e93da..7998bde8c6 100644 --- a/ShellPkg/Library/UefiShellDriver1CommandsLib/Devices.c +++ b/ShellPkg/Library/UefiShellDriver1CommandsLib/Devices.c @@ -17,25 +17,25 @@ /**
Get lots of info about a device from its handle.
- @param[in] TheHandle The device handle to get info on.
- @param[in,out] Type On successful return R, B, or D (root, bus, or
- device) will be placed in this buffer.
- @param[in,out] Cfg On successful return this buffer will be
- TRUE if the handle has configuration, FALSE
- otherwise.
- @param[in,out] Diag On successful return this buffer will be
- TRUE if the handle has disgnostics, FALSE
- otherwise.
- @param[in,out] Parents On successful return this buffer will be
- contain the number of parent handles.
- @param[in,out] Devices On successful return this buffer will be
- contain the number of devices controlled.
- @param[in,out] Children On successful return this buffer will be
- contain the number of child handles.
- @param[out] Name The pointer to a buffer that will be allocated
- and contain the string name of the handle.
- The caller must free this memory.
- @param[in] Language The language code as defined by the UEFI spec.
+ @param[in] TheHandle The device handle to get info on.
+ @param[in, out] Type On successful return R, B, or D (root, bus, or
+ device) will be placed in this buffer.
+ @param[in, out] Cfg On successful return this buffer will be
+ TRUE if the handle has configuration, FALSE
+ otherwise.
+ @param[in, out] Diag On successful return this buffer will be
+ TRUE if the handle has disgnostics, FALSE
+ otherwise.
+ @param[in, out] Parents On successful return this buffer will be
+ contain the number of parent handles.
+ @param[in, out] Devices On successful return this buffer will be
+ contain the number of devices controlled.
+ @param[in, out] Children On successful return this buffer will be
+ contain the number of child handles.
+ @param[out] Name The pointer to a buffer that will be allocated
+ and contain the string name of the handle.
+ The caller must free this memory.
+ @param[in] Language The language code as defined by the UEFI spec.
@retval EFI_SUCCESS The info is there.
@retval EFI_INVALID_PARAMETER A parameter was invalid.
diff --git a/ShellPkg/Library/UefiShellInstall1CommandsLib/Bcfg.c b/ShellPkg/Library/UefiShellInstall1CommandsLib/Bcfg.c index 78a4bd23d3..01f04a5472 100644 --- a/ShellPkg/Library/UefiShellInstall1CommandsLib/Bcfg.c +++ b/ShellPkg/Library/UefiShellInstall1CommandsLib/Bcfg.c @@ -49,8 +49,9 @@ typedef struct { /**
This function will populate the device path protocol parameter based on TheHandle.
-
- @param[in,out] DevPath On a sucessful return the device path to the handle.
+
+ @param[in] TheHandle Driver handle.
+ @param[in, out] FilePath On a sucessful return the device path to the handle.
@retval EFI_SUCCESS The device path was sucessfully returned.
@retval other A error from gBS->HandleProtocol.
diff --git a/ShellPkg/Library/UefiShellLevel1CommandsLib/For.c b/ShellPkg/Library/UefiShellLevel1CommandsLib/For.c index bc26ed31bc..4a85708d0b 100644 --- a/ShellPkg/Library/UefiShellLevel1CommandsLib/For.c +++ b/ShellPkg/Library/UefiShellLevel1CommandsLib/For.c @@ -120,9 +120,9 @@ typedef struct { /**
Update the value of a given alias on the list. If the alias is not there then add it.
- @param[in] Alias The alias to test for.
- @param[in] CommandString The updated command string.
- @param[in,out] List The list to search.
+ @param[in] Alias The alias to test for.
+ @param[in] CommandString The updated command string.
+ @param[in, out] List The list to search.
@retval EFI_SUCCESS The operation was completed successfully.
@retval EFI_OUT_OF_RESOURCES There was not enough free memory.
@@ -216,8 +216,8 @@ InternalIsAliasOnList( /**
Remove an alias from the given list.
- @param[in] Alias The alias to remove.
- @param[in,out] List The list to search.
+ @param[in] Alias The alias to remove.
+ @param[in, out] List The list to search.
**/
BOOLEAN
EFIAPI
diff --git a/ShellPkg/Library/UefiShellLevel1CommandsLib/If.c b/ShellPkg/Library/UefiShellLevel1CommandsLib/If.c index b7f423ff4d..d305306124 100644 --- a/ShellPkg/Library/UefiShellLevel1CommandsLib/If.c +++ b/ShellPkg/Library/UefiShellLevel1CommandsLib/If.c @@ -40,8 +40,8 @@ typedef enum { /**
Extract the next fragment, if there is one.
- @param[in,out] Statement The current remaining statement.
- @param[in] Fragment The current fragment.
+ @param[in, out] Statement The current remaining statement.
+ @param[in] Fragment The current fragment.
@retval FALSE There is not another fragment.
@retval TRUE There is another fragment.
@@ -338,15 +338,15 @@ TestOperation ( /**
Process an if statement and determine if its is valid or not.
- @param[in,out] PassingState Opon entry, the current state. Upon exit,
- the new state.
- @param[in] StartParameterNumber The number of the first parameter of
- this statement.
- @param[in] EndParameterNumber The number of the final parameter of
- this statement.
- @param[in] OperatorToUse The type of termination operator.
- @param[in] CaseInsensitive TRUE for case insensitive, FALSE otherwise.
- @param[in] ForceStringCompare TRUE for all string based, FALSE otherwise.
+ @param[in, out] PassingState Opon entry, the current state. Upon exit,
+ the new state.
+ @param[in] StartParameterNumber The number of the first parameter of
+ this statement.
+ @param[in] EndParameterNumber The number of the final parameter of
+ this statement.
+ @param[in] OperatorToUse The type of termination operator.
+ @param[in] CaseInsensitive TRUE for case insensitive, FALSE otherwise.
+ @param[in] ForceStringCompare TRUE for all string based, FALSE otherwise.
@retval EFI_INVALID_PARAMETER A parameter was invalid.
@retval EFI_SUCCESS The operation was successful.
diff --git a/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.c b/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.c index 72c5d07d52..7fc8690ceb 100644 --- a/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.c +++ b/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.c @@ -112,17 +112,17 @@ ShellLevel1CommandsLibDestructor ( If label is used it will be used instead of the count.
- @param[in] Function The function to use to enumerate through the
- list. Normally GetNextNode or GetPreviousNode.
- @param[in] DecrementerTag The tag to decrement the count at.
- @param[in] IncrementerTag The tag to increment the count at.
- @param[in] Label A label to look for.
- @param[in,out] ScriptFile The pointer to the current script file structure.
- @param[in] MovePast TRUE makes function return 1 past the found
- location.
- @param[in] FindOnly TRUE to not change the ScriptFile.
- @param[in] CommandNode The pointer to the Node to test.
- @param[in,out] TargetCount The pointer to the current count.
+ @param[in] Function The function to use to enumerate through the
+ list. Normally GetNextNode or GetPreviousNode.
+ @param[in] DecrementerTag The tag to decrement the count at.
+ @param[in] IncrementerTag The tag to increment the count at.
+ @param[in] Label A label to look for.
+ @param[in, out] ScriptFile The pointer to the current script file structure.
+ @param[in] MovePast TRUE makes function return 1 past the found
+ location.
+ @param[in] FindOnly TRUE to not change the ScriptFile.
+ @param[in] CommandNode The pointer to the Node to test.
+ @param[in, out] TargetCount The pointer to the current count.
**/
BOOLEAN
EFIAPI
@@ -229,17 +229,17 @@ TestNodeForMove ( If label is used it will be used instead of the count.
- @param[in] Function The function to use to enumerate through the
- list. Normally GetNextNode or GetPreviousNode.
- @param[in] DecrementerTag The tag to decrement the count at.
- @param[in] IncrementerTag The tag to increment the count at.
- @param[in] Label A label to look for.
- @param[in,out] ScriptFile The pointer to the current script file structure.
- @param[in] MovePast TRUE makes function return 1 past the found
- location.
- @param[in] FindOnly TRUE to not change the ScriptFile.
- @param[in] WrapAroundScript TRUE to wrap end-to-begining or vise versa in
- searching.
+ @param[in] Function The function to use to enumerate through the
+ list. Normally GetNextNode or GetPreviousNode.
+ @param[in] DecrementerTag The tag to decrement the count at.
+ @param[in] IncrementerTag The tag to increment the count at.
+ @param[in] Label A label to look for.
+ @param[in, out] ScriptFile The pointer to the current script file structure.
+ @param[in] MovePast TRUE makes function return 1 past the found
+ location.
+ @param[in] FindOnly TRUE to not change the ScriptFile.
+ @param[in] WrapAroundScript TRUE to wrap end-to-begining or vise versa in
+ searching.
**/
BOOLEAN
EFIAPI
diff --git a/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.h b/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.h index 7b3efd2f2c..e8439e7a8b 100644 --- a/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.h +++ b/ShellPkg/Library/UefiShellLevel1CommandsLib/UefiShellLevel1CommandsLib.h @@ -182,17 +182,17 @@ LIST_ENTRY * If label is used it will be used instead of the count.
- @param[in] Function The function to use to enumerate through the
- list. Normally GetNextNode or GetPreviousNode.
- @param[in] DecrementerTag The tag to decrement the count at.
- @param[in] IncrementerTag The tag to increment the count at.
- @param[in] Label A label to look for.
- @param[in,out] ScriptFile The pointer to the current script file structure.
- @param[in] MovePast TRUE makes function return 1 past the found
- location.
- @param[in] FindOnly TRUE to not change the ScriptFile.
- @param[in] WrapAroundScript TRUE to wrap end-to-begining or vise versa in
- searching.
+ @param[in] Function The function to use to enumerate through the
+ list. Normally GetNextNode or GetPreviousNode.
+ @param[in] DecrementerTag The tag to decrement the count at.
+ @param[in] IncrementerTag The tag to increment the count at.
+ @param[in] Label A label to look for.
+ @param[in, out] ScriptFile The pointer to the current script file structure.
+ @param[in] MovePast TRUE makes function return 1 past the found
+ location.
+ @param[in] FindOnly TRUE to not change the ScriptFile.
+ @param[in] WrapAroundScript TRUE to wrap end-to-begining or vise versa in
+ searching.
**/
BOOLEAN
EFIAPI
diff --git a/ShellPkg/Library/UefiShellLevel2CommandsLib/Mv.c b/ShellPkg/Library/UefiShellLevel2CommandsLib/Mv.c index 5afcea2310..b83eede5a9 100644 --- a/ShellPkg/Library/UefiShellLevel2CommandsLib/Mv.c +++ b/ShellPkg/Library/UefiShellLevel2CommandsLib/Mv.c @@ -116,9 +116,9 @@ IsValidMove( if the result is sucessful the caller must free *DestPathPointer.
- @param[in] DestDir The original path to the destination.
- @param[in,out] DestPathPointer A pointer to the callee allocated final path.
- @param[in] Cwd A pointer to the current working directory.
+ @param[in] DestDir The original path to the destination.
+ @param[in, out] DestPathPointer A pointer to the callee allocated final path.
+ @param[in] Cwd A pointer to the current working directory.
@retval EFI_INVALID_PARAMETR The DestDir could not be resolved to a location.
@retval EFI_INVALID_PARAMETR The DestDir could be resolved to more than 1 location.
diff --git a/ShellPkg/Library/UefiShellLib/UefiShellLib.c b/ShellPkg/Library/UefiShellLib/UefiShellLib.c index e824895cdb..598a2b479a 100644 --- a/ShellPkg/Library/UefiShellLib/UefiShellLib.c +++ b/ShellPkg/Library/UefiShellLib/UefiShellLib.c @@ -1313,8 +1313,8 @@ typedef struct { EFI_SHELL_FILE_INFO based list. it is up to the caller to free the memory via
the ShellCloseFileMetaArg function.
- @param[in] FileList the EFI shell list type
- @param[in,out] ListHead the list to add to
+ @param[in] FileList the EFI shell list type
+ @param[in, out] ListHead the list to add to
@retval the resultant head of the double linked new format list;
**/
@@ -2453,14 +2453,14 @@ ShellCommandLineCheckDuplicate ( If the string would grow bigger than NewSize it will halt and return error.
- @param[in] SourceString The string with source buffer.
- @param[in,out] NewString The string with resultant buffer.
- @param[in] NewSize The size in bytes of NewString.
- @param[in] FindTarget The string to look for.
- @param[in] ReplaceWith The string to replace FindTarget with.
- @param[in] SkipPreCarrot If TRUE will skip a FindTarget that has a '^'
- immediately before it.
- @param[in] ParameterReplacing If TRUE will add "" around items with spaces.
+ @param[in] SourceString The string with source buffer.
+ @param[in, out] NewString The string with resultant buffer.
+ @param[in] NewSize The size in bytes of NewString.
+ @param[in] FindTarget The string to look for.
+ @param[in] ReplaceWith The string to replace FindTarget with.
+ @param[in] SkipPreCarrot If TRUE will skip a FindTarget that has a '^'
+ immediately before it.
+ @param[in] ParameterReplacing If TRUE will add "" around items with spaces.
@retval EFI_INVALID_PARAMETER SourceString was NULL.
@retval EFI_INVALID_PARAMETER NewString was NULL.
@@ -3020,8 +3020,8 @@ ShellStrToUintn( if Destination's current length (including NULL terminator) is already more then
CurrentSize, then ASSERT()
- @param[in,out] Destination The String to append onto
- @param[in,out] CurrentSize on call the number of bytes in Destination. On
+ @param[in, out] Destination The String to append onto
+ @param[in, out] CurrentSize on call the number of bytes in Destination. On
return possibly the new size (still in bytes). if NULL
then allocate whatever is needed.
@param[in] Source The String to append from
@@ -3824,9 +3824,9 @@ ShellIsHexOrDecimalNumber ( If the position upon start is 0, then the Ascii Boolean will be set. This should be
maintained and not changed for all operations with the same file.
- @param[in] Handle SHELL_FILE_HANDLE to read from.
- @param[in,out] Ascii Boolean value for indicating whether the file is
- Ascii (TRUE) or UCS2 (FALSE).
+ @param[in] Handle SHELL_FILE_HANDLE to read from.
+ @param[in, out] Ascii Boolean value for indicating whether the file is
+ Ascii (TRUE) or UCS2 (FALSE).
@return The line of text from the file.
@@ -3865,17 +3865,17 @@ ShellFileHandleReturnLine( If the position upon start is 0, then the Ascii Boolean will be set. This should be
maintained and not changed for all operations with the same file.
- @param[in] Handle SHELL_FILE_HANDLE to read from.
- @param[in,out] Buffer The pointer to buffer to read into.
- @param[in,out] Size The pointer to number of bytes in Buffer.
- @param[in] Truncate If the buffer is large enough, this has no effect.
- If the buffer is is too small and Truncate is TRUE,
- the line will be truncated.
- If the buffer is is too small and Truncate is FALSE,
- then no read will occur.
-
- @param[in,out] Ascii Boolean value for indicating whether the file is
- Ascii (TRUE) or UCS2 (FALSE).
+ @param[in] Handle SHELL_FILE_HANDLE to read from.
+ @param[in, out] Buffer The pointer to buffer to read into.
+ @param[in, out] Size The pointer to number of bytes in Buffer.
+ @param[in] Truncate If the buffer is large enough, this has no effect.
+ If the buffer is is too small and Truncate is TRUE,
+ the line will be truncated.
+ If the buffer is is too small and Truncate is FALSE,
+ then no read will occur.
+
+ @param[in, out] Ascii Boolean value for indicating whether the file is
+ Ascii (TRUE) or UCS2 (FALSE).
@retval EFI_SUCCESS The operation was successful. The line is stored in
Buffer.
diff --git a/ShellPkg/Library/UefiShellNetwork1CommandsLib/Ifconfig.c b/ShellPkg/Library/UefiShellNetwork1CommandsLib/Ifconfig.c index 13d24969f8..b4c4233849 100644 --- a/ShellPkg/Library/UefiShellNetwork1CommandsLib/Ifconfig.c +++ b/ShellPkg/Library/UefiShellNetwork1CommandsLib/Ifconfig.c @@ -249,10 +249,10 @@ GetChildHandle ( /**
Append OFFSET/WIDTH/VALUE items at the beginning of string.
- @param[in,out] String The pointer to the string to append onto.
- @param[in] Offset Offset value.
- @param[in] Width Width value.
- @param[in] Block Point to data buffer.
+ @param[in, out] String The pointer to the string to append onto.
+ @param[in] Offset Offset value.
+ @param[in] Width Width value.
+ @param[in] Block Point to data buffer.
@return The count of unicode character that were appended.
**/
diff --git a/ShellPkg/Library/UefiSortLib/UefiSortLib.c b/ShellPkg/Library/UefiSortLib/UefiSortLib.c index 4b89358f1a..73ee7830fc 100644 --- a/ShellPkg/Library/UefiSortLib/UefiSortLib.c +++ b/ShellPkg/Library/UefiSortLib/UefiSortLib.c @@ -43,13 +43,13 @@ STATIC EFI_UNICODE_COLLATION_PROTOCOL *mUnicodeCollation = NULL; if Count is < 2 then perform no action.
if Size is < 1 then perform no action.
- @param[in,out] BufferToSort on call a Buffer of (possibly sorted) elements
- on return a buffer of sorted elements
- @param[in] Count the number of elements in the buffer to sort
- @param[in] ElementSize Size of an element in bytes
- @param[in] CompareFunction The function to call to perform the comparison
- of any 2 elements
- @param[in] Buffer Buffer of size ElementSize for use in swapping
+ @param[in, out] BufferToSort on call a Buffer of (possibly sorted) elements
+ on return a buffer of sorted elements
+ @param[in] Count the number of elements in the buffer to sort
+ @param[in] ElementSize Size of an element in bytes
+ @param[in] CompareFunction The function to call to perform the comparison
+ of any 2 elements
+ @param[in] Buffer Buffer of size ElementSize for use in swapping
**/
VOID
EFIAPI
@@ -149,12 +149,12 @@ QuickSortWorker ( if Count is < 2 then perform no action.
if Size is < 1 then perform no action.
- @param[in,out] BufferToSort on call a Buffer of (possibly sorted) elements
- on return a buffer of sorted elements
- @param[in] Count the number of elements in the buffer to sort
- @param[in] ElementSize Size of an element in bytes
- @param[in] CompareFunction The function to call to perform the comparison
- of any 2 elements
+ @param[in, out] BufferToSort on call a Buffer of (possibly sorted) elements
+ on return a buffer of sorted elements
+ @param[in] Count the number of elements in the buffer to sort
+ @param[in] ElementSize Size of an element in bytes
+ @param[in] CompareFunction The function to call to perform the comparison
+ of any 2 elements
**/
VOID
EFIAPI
|