Revision: 14998
          http://sourceforge.net/p/edk2/code/14998
Author:   jcarsey
Date:     2013-12-17 22:23:05 +0000 (Tue, 17 Dec 2013)
Log Message:
-----------
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 <[email protected]>
Reviewed-by: Erik Bjorge <[email protected]>

Modified Paths:
--------------
    trunk/edk2/ShellPkg/Application/Shell/Shell.c

Modified: trunk/edk2/ShellPkg/Application/Shell/Shell.c
===================================================================
--- trunk/edk2/ShellPkg/Application/Shell/Shell.c       2013-12-17 21:40:41 UTC 
(rev 14997)
+++ trunk/edk2/ShellPkg/Application/Shell/Shell.c       2013-12-17 22:23:05 UTC 
(rev 14998)
@@ -1434,8 +1434,8 @@
   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 @@
 
 /**
   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 @@
 }
 
 /**
+  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

This was sent by the SourceForge.net collaborative development platform, the 
world's largest Open Source development site.


------------------------------------------------------------------------------
Rapidly troubleshoot problems before they affect your business. Most IT 
organizations don't have a clear picture of how application performance 
affects their revenue. With AppDynamics, you get 100% visibility into your 
Java,.NET, & PHP application. Start your 15-day FREE TRIAL of AppDynamics Pro!
http://pubads.g.doubleclick.net/gampad/clk?id=84349831&iu=/4140/ostg.clktrk
_______________________________________________
edk2-commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/edk2-commits

Reply via email to