diff options
| author | Jaben Carsey <jaben.carsey@intel.com> | 2013-12-17 22:23:05 +0000 |
|---|---|---|
| committer | jcarsey <jcarsey@6f19259b-4bc3-4df7-8a09-765794883524> | 2013-12-17 22:23:05 +0000 |
| commit | e7831c9070bc832f7ef8eee58c99a66653a17d56 (patch) | |
| tree | 19766028090d23f5c0cc0a6e4c6b9026611dc99d /ShellPkg/Application/Shell | |
| parent | c81863953f2aca16b2347e7e9977a06fcd1f13aa (diff) | |
| download | edk2-platforms-e7831c9070bc832f7ef8eee58c99a66653a17d56.tar.xz | |
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
Diffstat (limited to 'ShellPkg/Application/Shell')
| -rw-r--r-- | ShellPkg/Application/Shell/Shell.c | 18 |
1 files changed, 16 insertions, 2 deletions
diff --git a/ShellPkg/Application/Shell/Shell.c b/ShellPkg/Application/Shell/Shell.c index 6822f52e81..7a7bb1e736 100644 --- a/ShellPkg/Application/Shell/Shell.c +++ b/ShellPkg/Application/Shell/Shell.c @@ -1434,8 +1434,8 @@ RunSplitCommand( Take the original command line, substitute any variables, free
the original string, return the modified copy
- @param[in] CmdLine pointer to the command line to update
- @param[out]CmdName upon successful return the name of the command to be run
+ @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
@retval EFI_SUCCESS the function was successful
@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.
+
+ @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
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
EFIAPI
|