Restore Include/Library/ShellCEntryLib.h. Cleanup function and

[mirror_edk2.git] / ShellPkg / Library / UefiShellCEntryLib / UefiShellCEntryLib.c

diff --git a/ShellPkg/Library/UefiShellCEntryLib/UefiShellCEntryLib.c b/ShellPkg/Library/UefiShellCEntryLib/UefiShellCEntryLib.c
index ce41166573eb6adad0168e8cc34ff40a07145b99..43d429e6a560f4244d7bfe8fae9e1362d256138f 100644 (file)
--- a/ShellPkg/Library/UefiShellCEntryLib/UefiShellCEntryLib.c
+++ b/ShellPkg/Library/UefiShellCEntryLib/UefiShellCEntryLib.c
@@ -18,6 +18,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Protocol/EfiShellInterface.h>\r
 #include <Protocol/EfiShellParameters.h>\r
 \r
+#include <Library/ShellCEntryLib.h>\r
 #include <Library/DebugLib.h>\r
 \r
 INTN\r
@@ -28,17 +29,19 @@ ShellAppMain (
   );\r
 \r
 /**\r
-  UEFI entry point for an application that will in turn call a C \r
-  style ShellAppMain function.\r
+  UEFI entry point for an application that will in turn call the\r
+  ShellAppMain function which has parameters similar to a standard C\r
+  main function.\r
 \r
-  This application must have a function defined as follows:\r
+  An application that uses UefiShellCEntryLib must have a ShellAppMain\r
+  function as prototyped in Include/Library/ShellCEntryLib.h.\r
+\r
+  @param  ImageHandle  The image handle of the UEFI Application.\r
+  @param  SystemTable  A pointer to the EFI System Table.\r
+\r
+  @retval  EFI_SUCCESS               The application exited normally.\r
+  @retval  Other                     An error occurred.\r
 \r
-  INTN\r
-  EFIAPI\r
-  ShellAppMain (\r
-    IN INTN Argc, \r
-    IN CHAR16 **Argv\r
-    );\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r