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

[mirror_edk2.git] / MdePkg / Include / Protocol / VariableWrite.h

/** @file\r
  Variable Write Architectural Protocol as defined in PI Specification VOLUME 2 DXE\r
\r
  This code is used to produce the UEFI 2.0 runtime variable services\r
\r
  The SetVariable () UEFI 2.0 services may be updated to the EFI system table and the \r
  EFI_VARIABLE_WRITE_ARCH_PROTOCOL_GUID protocol is registered with a NULL pointer.\r
\r
  No CRC of the EFI system table is required, as it is done in the DXE core.\r
\r
  Copyright (c) 2006 - 2008, 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
\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 __ARCH_PROTOCOL_VARIABLE_WRITE_ARCH_H__\r
#define __ARCH_PROTOCOL_VARIABLE_WRITE_ARCH_H__\r
\r
///\r
/// Global ID for the Variable Write Architectural Protocol\r
///\r
#define EFI_VARIABLE_WRITE_ARCH_PROTOCOL_GUID \\r
  { 0x6441f818, 0x6362, 0x4e44, {0xb5, 0x70, 0x7d, 0xba, 0x31, 0xdd, 0x24, 0x53 } }\r
\r
extern EFI_GUID gEfiVariableWriteArchProtocolGuid;\r
\r
#endif \r