summaryrefslogtreecommitdiff
path: root/ShellPkg/Application
diff options
context:
space:
mode:
authorShumin Qiu <shumin.qiu@intel.com>2014-01-23 00:27:52 +0000
committershenshushi <shenshushi@6f19259b-4bc3-4df7-8a09-765794883524>2014-01-23 00:27:52 +0000
commitf614ce7ebb1f131a9cd508048ee1123eef5b30a7 (patch)
treef88d5e43cbd94d35dfafb4959489add662bd9fa0 /ShellPkg/Application
parent7798fb83de4b2505a8e17457256b113a05d8475c (diff)
downloadedk2-platforms-f614ce7ebb1f131a9cd508048ee1123eef5b30a7.tar.xz
Update the comments in function headers to follow Doxygen special documentation blocks in section 2.3.5.
Signed-off-by: Shumin Qiu <shumin.qiu@intel.com> Reviewed-by: Jaben Carsey <Jaben.carsey@intel.com> git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15163 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'ShellPkg/Application')
-rw-r--r--ShellPkg/Application/Shell/ShellParametersProtocol.c4
1 files changed, 4 insertions, 0 deletions
diff --git a/ShellPkg/Application/Shell/ShellParametersProtocol.c b/ShellPkg/Application/Shell/ShellParametersProtocol.c
index ab435a1263..7809a0e0d7 100644
--- a/ShellPkg/Application/Shell/ShellParametersProtocol.c
+++ b/ShellPkg/Application/Shell/ShellParametersProtocol.c
@@ -570,6 +570,10 @@ FixVarName (
/**
Remove the unicode file tag from the begining of the file buffer since that will not be
used by StdIn.
+
+ @param[in] Handle Pointer to the handle of the file to be processed.
+
+ @retval EFI_SUCCESS The unicode file tag has been moved successfully.
**/
EFI_STATUS
EFIAPI