add comments to function declarations and definitions and updated to match coding...

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

/** @file\r
  Provides application point extension for "C" style main funciton.\r
\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
\r
**/\r
\r
#ifndef _SHELL_C_ENTRY_LIB_\r
#define _SHELL_C_ENTRY_LIB_\r
\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
INTN\r
EFIAPI\r
ShellAppMain (\r
  IN UINTN Argc,\r
  IN CHAR16 **Argv\r
  );\r
\r
#endif\r
\r