Update the copyright notice format

[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 7cee1f08b55fbfca0f0ac7b52efc38cb11945f93..963a50b961175cabd03b0726e7daa74e7e93ba5d 100644 (file)
--- a/MdeModulePkg/Universal/Variable/Pei/Variable.h
+++ b/MdeModulePkg/Universal/Variable/Pei/Variable.h
@@ -3,8 +3,8 @@
   The internal header file includes the common header files, defines\r
   internal structure and functions used by PeiVariable module.\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2008, 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
@@ -41,11 +41,18 @@ typedef struct {
 #define EFI_VARIABLE_INDEX_TABLE_GUID \\r
   { 0x8cfdb8c8, 0xd6b2, 0x40f3, { 0x8e, 0x97, 0x02, 0x30, 0x7c, 0xc9, 0x8b, 0x7c } }\r
 \r
+///\r
+/// Use this data structure to store variable-related info, which can decrease\r
+/// the cost of access to NV.\r
+///\r
 typedef struct {\r
   UINT16          Length;\r
   UINT16          GoneThrough;\r
   VARIABLE_HEADER *EndPtr;\r
   VARIABLE_HEADER *StartPtr;\r
+  ///\r
+  /// This field is used to store the distance of two neighbouring VAR_ADDED type variables.\r
+  /// The meaning of the field is implement-dependent.\r
   UINT16          Index[VARIABLE_INDEX_TABLE_VOLUME];\r
 } VARIABLE_INDEX_TABLE;\r
 \r
@@ -146,34 +153,4 @@ PeiGetNextVariableName (
   IN OUT EFI_GUID                           *VariableGuid\r
   );\r
 \r
-/**\r
-  Get one variable by the index count.\r
-\r
-  @param  IndexTable  The pointer to variable index table.\r
-  @param  Count       The index count of variable in index table.\r
-\r
-  @return The pointer to variable header indexed by count.\r
-\r
-**/\r
-VARIABLE_HEADER *\r
-GetVariableByIndex (\r
-  IN VARIABLE_INDEX_TABLE        *IndexTable,\r
-  IN UINT32                      Count\r
-  );\r
-\r
-/**\r
-  Record Variable in VariableIndex HOB.\r
-\r
-  Record Variable in VariableIndex HOB and update the length of variable index table.\r
-\r
-  @param  IndexTable  The pointer to variable index table.\r
-  @param  Variable    The pointer to the variable that will be recorded.\r
-\r
-**/\r
-VOID\r
-VariableIndexTableUpdate (\r
-  IN OUT  VARIABLE_INDEX_TABLE   *IndexTable,\r
-  IN      VARIABLE_HEADER        *Variable\r
-  );\r
-\r
 #endif\r