1. Removed #ifdef EDK_RELEASE_VERSION from all c files for all modules

[mirror_edk2.git] / EdkModulePkg / Universal / Variable / Pei / Ipf / VariableWorker.c

diff --git a/EdkModulePkg/Universal/Variable/Pei/Ipf/VariableWorker.c b/EdkModulePkg/Universal/Variable/Pei/Ipf/VariableWorker.c
index 302bc14689116e453c8bb890da6c18c5e78bbf3c..0a4ee9577472dc6c7d3219041510cdfb577d1481 100644 (file)
--- a/EdkModulePkg/Universal/Variable/Pei/Ipf/VariableWorker.c
+++ b/EdkModulePkg/Universal/Variable/Pei/Ipf/VariableWorker.c
@@ -1,27 +1,29 @@
-/*++\r
+/** @file\r
+  Variable worker functions.\r
 \r
-Copyright (c) 2007, 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
+  Copyright (c) 2006, 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
+  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
 \r
-  VariableWorker.c\r
-\r
-Abstract:\r
+#include <Variable.h>\r
 \r
-  Framework PEIM to provide the Variable functionality\r
 \r
---*/\r
+/**\r
+  Get one variable by the index count.\r
 \r
-#include <Variable.h>\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
@@ -31,6 +33,17 @@ GetVariableByIndex (
   return (VARIABLE_HEADER *) (UINTN) ((((UINT32)IndexTable->Index[Count]) << 2) + ((UINT32)(UINTN)IndexTable->StartPtr & 0xFFFC0000) );\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
+  @retval VOID\r
+\r
+**/\r
 VOID\r
 VariableIndexTableUpdate (\r
   IN OUT  VARIABLE_INDEX_TABLE   *IndexTable,\r