Add comments and DoxyGen format for these files.

[mirror_edk2.git] / MdeModulePkg / Universal / Variable / Pei / Variable.h

diff --git a/MdeModulePkg/Universal/Variable/Pei/Variable.h b/MdeModulePkg/Universal/Variable/Pei/Variable.h
index 7155cda73c0a76f523d0adf2a797ad08876c0ab4..c2c16db41512aac40076daf2f98bbcd231472389 100644 (file)
--- a/MdeModulePkg/Universal/Variable/Pei/Variable.h
+++ b/MdeModulePkg/Universal/Variable/Pei/Variable.h
@@ -1,6 +1,9 @@
-/*++\r
+/** @file\r
+\r
+  The internal header file includes the common header files, defines\r
+  internal structure and functions used by PeiVariable module.\r
 \r
-Copyright (c) 2006 - 2007, Intel Corporation\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
@@ -9,15 +12,7 @@ http://opensource.org/licenses/bsd-license.php
 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
-Module Name:\r
-\r
-  Variable.h\r
-\r
-Abstract:\r
-\r
-  Tiano PEIM to provide the variable functionality\r
-\r
---*/\r
+**/\r
 \r
 #ifndef _PEI_VARIABLE_H\r
 #define _PEI_VARIABLE_H\r
@@ -41,10 +36,7 @@ Abstract:
 #define GET_PAD_SIZE(a) (((~a) + 1) & (ALIGNMENT - 1))\r
 #endif\r
 \r
-#define GET_VARIABLE_NAME_PTR(a)  (CHAR16 *) ((UINTN) (a) + sizeof (VARIABLE_HEADER))\r
-\r
-#define GET_VARIABLE_DATA_PTR(a) \\r
-  (UINT8 *) ((UINTN) GET_VARIABLE_NAME_PTR (a) + (a)->NameSize + GET_PAD_SIZE ((a)->NameSize))\r
+#define HEADER_ALIGN(Header)  (((UINTN) (Header) + HEADER_ALIGNMENT - 1) & (~(HEADER_ALIGNMENT - 1)))\r
 \r
 typedef struct {\r
   VARIABLE_HEADER *CurrPtr;\r