ShellPkg: Add missing function header comments

I found that some function headers had insufficient/incorrect information.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jaben Carsey <jaben.carsey@intel.com>
Reviewed-by: Erik Bjorge <erik.c.bjorge@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@14998 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
Jaben Carsey 2013-12-17 22:23:05 +00:00 committed by jcarsey
parent c81863953f
commit e7831c9070
1 changed files with 16 additions and 2 deletions

View File

@ -1434,8 +1434,8 @@ RunSplitCommand(
Take the original command line, substitute any variables, free Take the original command line, substitute any variables, free
the original string, return the modified copy the original string, return the modified copy
@param[in] CmdLine pointer to the command line to update @param[in,out] CmdLine pointer to the command line to update
@param[out]CmdName upon successful return the name of the command to be run @param[out]CmdName upon successful return the name of the command to be run
@retval EFI_SUCCESS the function was successful @retval EFI_SUCCESS the function was successful
@retval EFI_OUT_OF_RESOURCES a memory allocation failed @retval EFI_OUT_OF_RESOURCES a memory allocation failed
@ -1529,6 +1529,14 @@ ShellSubstituteAliases(
/** /**
Takes the Argv[0] part of the command line and determine the meaning of it. Takes the Argv[0] part of the command line and determine the meaning of it.
@param[in] CmdLine pointer to the command line to update
@retval INTERNAL_COMMAND The name is an internal command
@retval FILE_SYS_CHANGE the name is a file system change
@retval SCRIPT_FILE_NAME the name is a NSH script file
@retval UNKNOWN_INVALID the name is unknown
@retval EFI_APPLICATION the name is an application (.EFI)
**/ **/
SHELL_OPERATION_TYPES SHELL_OPERATION_TYPES
EFIAPI EFIAPI
@ -1589,6 +1597,12 @@ GetOperationType(
} }
/** /**
Process a split based operation.
@param[in] CmdLine pointer to the command line to process
@retval EFI_SUCCESS The operation was successful
@return an error occured.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI