1 files changed, 28 insertions, 15 deletions
diff --git a/EdkModulePkg/Universal/Variable/Pei/Ipf/VariableWorker.c b/EdkModulePkg/Universal/Variable/Pei/Ipf/VariableWorker.c
index 302bc14689..0a4ee95774 100644
--- a/EdkModulePkg/Universal/Variable/Pei/Ipf/VariableWorker.c
+++ b/EdkModulePkg/Universal/Variable/Pei/Ipf/VariableWorker.c
@@ -1,27 +1,29 @@
-/*++
+/** @file
+  Variable worker functions.
 
-Copyright (c) 2007, Intel Corporation
-All rights reserved. This program and the accompanying materials
-are licensed and made available under the terms and conditions of the BSD License
-which accompanies this distribution.  The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php
+  Copyright (c) 2006, Intel Corporation<BR>
+  All rights reserved. This program and the accompanying materials
+  are licensed and made available under the terms and conditions of the BSD License
+  which accompanies this distribution.  The full text of the license may be found at
+  http://opensource.org/licenses/bsd-license.php
 
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
-Module Name:
+**/
 
-  VariableWorker.c
-
-Abstract:
+#include <Variable.h>
 
-  Framework PEIM to provide the Variable functionality
 
---*/
+/**
+  Get one variable by the index count.
 
-#include <Variable.h>
+  @param  IndexTable  The pointer to variable index table.
+  @param  Count       The index count of variable in index table.
 
+  @return The pointer to variable header indexed by count.
 
+**/
 VARIABLE_HEADER *
 GetVariableByIndex (
   IN VARIABLE_INDEX_TABLE        *IndexTable,
@@ -31,6 +33,17 @@ GetVariableByIndex (
   return (VARIABLE_HEADER *) (UINTN) ((((UINT32)IndexTable->Index[Count]) << 2) + ((UINT32)(UINTN)IndexTable->StartPtr & 0xFFFC0000) );
 }
 
+/**
+  Record Variable in VariableIndex HOB.
+
+  Record Variable in VariableIndex HOB and update the length of variable index table.
+
+  @param  IndexTable  The pointer to variable index table.
+  @param  Variable    The pointer to the variable that will be recorded.
+
+  @retval VOID
+
+**/
 VOID
 VariableIndexTableUpdate (
   IN OUT  VARIABLE_INDEX_TABLE   *IndexTable,