Add comments and DoxyGen format for these files.

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

diff --git a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/Variable.h b/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/Variable.h
index 1e445c564bc3d44269aef40e0cc7b5718dcdedfc..88e9dd6e9bdbae03293f6c4ba40153b42b0b5464 100644 (file)
--- a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/Variable.h
+++ b/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/Variable.h
@@ -1,6 +1,9 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2006 - 2007, Intel Corporation\r
+  The internal header file includes the common header files, defines\r
+  internal structure and functions used by EmuVariable module.\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
@@ -9,13 +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
---*/\r
+**/\r
 \r
 #ifndef _VARIABLE_H\r
 #define _VARIABLE_H\r
@@ -23,18 +20,12 @@ Abstract:
 //\r
 // Statements that include other header files\r
 //\r
-//\r
-// The package level header files this module uses\r
-//\r
+\r
 #include <PiDxe.h>\r
-//\r
-// The protocols, PPI and GUID defintions for this module\r
-//\r
+\r
 #include <Protocol/VariableWrite.h>\r
 #include <Protocol/Variable.h>\r
-//\r
-// The Library classes this module consumes\r
-//\r
+\r
 #include <Library/BaseMemoryLib.h>\r
 #include <Library/MemoryAllocationLib.h>\r
 #include <Library/DebugLib.h>\r
@@ -43,14 +34,11 @@ Abstract:
 #include <Library/UefiBootServicesTableLib.h>\r
 #include <Library/UefiLib.h>\r
 #include <Library/BaseLib.h>\r
+#include <Library/PcdLib.h>\r
+#include <VariableFormat.h>\r
 \r
-//\r
-// BugBug: We need relcate the head file.\r
-//\r
-#include <Common/Variable.h>\r
-\r
-#define VARIABLE_STORE_SIZE (64 * 1024)\r
-#define SCRATCH_SIZE        (4 * 1024)\r
+#define VARIABLE_STORE_SIZE FixedPcdGet32(PcdVariableStoreSize)\r
+#define SCRATCH_SIZE        FixedPcdGet32(PcdMaxVariableSize)\r
 \r
 //\r
 // Define GET_PAD_SIZE to optimize compiler\r