Use doxygen comment style for document entity such as struct, enum, variable that...

[mirror_edk2.git] / MdePkg / Include / Library / UefiApplicationEntryPoint.h

/** @file\r
  Entry point to a UEFI Application.\r
\r
Copyright (c) 2007, Intel Corporation<BR>\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
\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 __UEFI_APPLICATION_ENTRY_POINT_H__\r
#define __UEFI_APPLICATION_ENTRY_POINT_H__\r
\r
///\r
/// Declare the EFI/UEFI Specification Revision to which this driver is implemented \r
///\r
extern const UINT32                   _gUefiDriverRevision;\r
\r
/**\r
  Enrty point to UEFI Application.\r
\r
  @param  ImageHandle ImageHandle of the loaded driver.\r
  @param  SystemTable Pointer to the EFI System Table.\r
\r
  @retval  EFI_SUCCESS One or more of the drivers returned a success code.\r
  @retval  !EFI_SUCESS The return status from the last driver entry point in the list.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
_ModuleEntryPoint (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
\r
/**\r
  Enrty point wrapper of UEFI Application.\r
\r
  @param  ImageHandle ImageHandle of the loaded driver.\r
  @param  SystemTable Pointer to the EFI System Table.\r
\r
  @retval  EFI_SUCCESS One or more of the drivers returned a success code.\r
  @retval  !EFI_SUCESS The return status from the last driver entry point in the list.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EfiMain (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
\r
/**\r
  Invoke the destuctors of all libraries and call gBS->Exit\r
  to return control to firmware core.\r
\r
  @param  Status Status returned by the application that is exiting.\r
  \r
**/\r
VOID\r
EFIAPI\r
Exit (\r
  IN EFI_STATUS  Status\r
  );\r
\r
\r
/**\r
  Call constructors for all libraries.  Autogen tool inserts the implementation\r
  of this function into Autogen.c.\r
\r
  @param  ImageHandle ImageHandle of the loaded driver.\r
  @param  SystemTable Pointer to the EFI System Table.\r
  \r
**/\r
VOID\r
EFIAPI\r
ProcessLibraryConstructorList (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
\r
/**\r
  Call destructors for all libraries. Autogen tool inserts the implementation\r
  of this function into Autogen.c.\r
\r
  @param  ImageHandle ImageHandle of the loaded driver.\r
  @param  SystemTable Pointer to the EFI System Table.\r
\r
**/\r
VOID\r
EFIAPI\r
ProcessLibraryDestructorList (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
/**\r
  Call driver entry point. For UEFI application, user\r
  can only specify one entry point. Tool will automatically insert\r
  this to Autogen.c.\r
\r
  @param  ImageHandle ImageHandle of the loaded driver.\r
  @param  SystemTable Pointer to the EFI System Table.\r
\r
  @return Status returned by entry points specified by\r
          the user.  \r
 \r
**/\r
EFI_STATUS\r
EFIAPI\r
ProcessModuleEntryPointList (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  );\r
\r
#endif\r