Comment's added and fixed.

[mirror_edk2.git] / ShellPkg / Include / Library / ShellCEntryLib.h

diff --git a/ShellPkg/Include/Library/ShellCEntryLib.h b/ShellPkg/Include/Library/ShellCEntryLib.h
index 762c95b598184d286e377cfa43c832b9328a2ea0..79136a6894d98a09bdcac3d60c32724c5c05ab09 100644 (file)
--- a/ShellPkg/Include/Library/ShellCEntryLib.h
+++ b/ShellPkg/Include/Library/ShellCEntryLib.h
@@ -1,32 +1,40 @@
 /** @file\r
-  Provides application point extension for "C" style main funciton \r
+  Provides application point extension for "C" style main funciton.\r
 \r
-Copyright (c) 2006 - 2009, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution.  The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
+  Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials\r
+  are licensed and made available under the terms and conditions of the BSD License\r
+  which accompanies this distribution.  The full text of the license may be found at\r
+  http://opensource.org/licenses/bsd-license.php\r
 \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r
 \r
+#if !defined (_SHELL_C_ENTRY_LIB_)\r
+#define _SHELL_C_ENTRY_LIB_\r
+\r
 /**\r
-  Intermediate entry point for the application that will in turn call into the "C" \r
-  style main function.\r
-\r
-  this application must have a function like:\r
-  INT32 \r
-  EFIAPI \r
-  main(\r
-    UINTN Argc, \r
-    CHAR16 **Argv\r
-  );\r
+  UEFI application entry point which has an interface similar to a\r
+  standard C main function.\r
+\r
+  The ShellCEntryLib library instance wrappers the actual UEFI application\r
+  entry point and calls this ShellAppMain function.\r
+\r
+  @param[in]  Argc  The number of parameters.\r
+  @param[in]  Argv  The array of pointers to parameters.\r
+\r
+  @retval  0               The application exited normally.\r
+  @retval  Other           An error occurred.\r
+\r
 **/\r
-EFI_STATUS\r
+INTN\r
 EFIAPI\r
-ShellCEntry(\r
-  IN EFI_HANDLE        ImageHandle,\r
-  IN EFI_SYSTEM_TABLE  *SystemTable\r
-  );
\ No newline at end of file
+ShellAppMain (\r
+  IN UINTN Argc,\r
+  IN CHAR16 **Argv\r
+  );\r
+\r
+#endif\r
+\r