Add comments and DoxyGen format for these files.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5028 6f19259b-4bc3-4df7-8a09-765794883524

12 files changed, 73 insertions, 122 deletions

diff --git a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariable.c b/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariable.c
index 5e4688929a..158e396963 100644
--- a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariable.c
+++ b/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/EmuVariable.c
@@ -1,6 +1,9 @@
-/*++

+/** @file

+

+  Emulation Variable services operate on the runtime volatile memory.

+  The nonvolatile variable space doesn't exist.

 

-Copyright (c) 2006 - 2007, Intel Corporation

+Copyright (c) 2006 - 2008, 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

@@ -9,15 +12,7 @@ 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.

 

-Module Name:

-

-    EmuVariable.c

-

-Abstract:

-

-Revision History

-

---*/

+**/

 

 #include "Variable.h"

 

diff --git a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/InitVariable.c b/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/InitVariable.c
index efff41c253..c774604215 100644
--- a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/InitVariable.c
+++ b/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/InitVariable.c
@@ -1,6 +1,9 @@
-/*++

+/** @file

 

-Copyright (c) 2006 - 2007, Intel Corporation

+  Implment all four UEFI runtime variable services and 

+  install variable architeture protocol.

+  

+Copyright (c) 2006 - 2008, 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

@@ -9,15 +12,7 @@ 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.

 

-Module Name:

-

-  InitVariable.c

-

-Abstract:

-

-Revision History

-

---*/

+**/

 

 #include "Variable.h"

 

diff --git a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/Variable.h b/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/Variable.h
index af6ed2d255..88e9dd6e9b 100644
--- a/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/Variable.h
+++ b/MdeModulePkg/Universal/Variable/EmuRuntimeDxe/Variable.h
@@ -1,6 +1,9 @@
-/*++

+/** @file

 

-Copyright (c) 2006 - 2007, Intel Corporation

+  The internal header file includes the common header files, defines

+  internal structure and functions used by EmuVariable module.

+

+Copyright (c) 2006 - 2008, 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

@@ -9,13 +12,7 @@ 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.

 

-Module Name:

-

-  Variable.h

-

-Abstract:

-

---*/

+**/

 

 #ifndef _VARIABLE_H

 #define _VARIABLE_H

diff --git a/MdeModulePkg/Universal/Variable/Pei/Ipf/VariableWorker.c b/MdeModulePkg/Universal/Variable/Pei/Ipf/VariableWorker.c
index 0a4ee95774..4a700340e6 100644
--- a/MdeModulePkg/Universal/Variable/Pei/Ipf/VariableWorker.c
+++ b/MdeModulePkg/Universal/Variable/Pei/Ipf/VariableWorker.c
@@ -1,7 +1,8 @@
 /** @file

-  Variable worker functions.

 

-  Copyright (c) 2006, Intel Corporation<BR>

+  Variable worker functions specific for IPF arch.

+

+  Copyright (c) 2006 - 2008, 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

diff --git a/MdeModulePkg/Universal/Variable/Pei/Variable.c b/MdeModulePkg/Universal/Variable/Pei/Variable.c
index 24e051cf1f..517d38130b 100644
--- a/MdeModulePkg/Universal/Variable/Pei/Variable.c
+++ b/MdeModulePkg/Universal/Variable/Pei/Variable.c
@@ -1,4 +1,7 @@
-/*++

+/** @file

+

+  Implement ReadOnly Variable Services required by PEIM and install

+  PI ReadOnly Varaiable2 PPI. These services operates the non volatile storage space.

 

 Copyright (c) 2006 - 2008 Intel Corporation. <BR>

 All rights reserved. This program and the accompanying materials

@@ -10,13 +13,7 @@ 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:

 

-  Variable.c

-

-Abstract:

-

-  PEIM to provide the Variable functionality

-

---*/

+**/

 

 

 #include "Variable.h"

diff --git a/MdeModulePkg/Universal/Variable/Pei/Variable.h b/MdeModulePkg/Universal/Variable/Pei/Variable.h
index 965f722f38..c2c16db415 100644
--- a/MdeModulePkg/Universal/Variable/Pei/Variable.h
+++ b/MdeModulePkg/Universal/Variable/Pei/Variable.h
@@ -1,6 +1,9 @@
-/*++

+/** @file

+

+  The internal header file includes the common header files, defines

+  internal structure and functions used by PeiVariable module.

 

-Copyright (c) 2006 - 2007, Intel Corporation

+Copyright (c) 2006 - 2008, 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

@@ -9,15 +12,7 @@ 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.

 

-Module Name:

-

-  Variable.h

-

-Abstract:

-

-  Tiano PEIM to provide the variable functionality

-

---*/

+**/

 

 #ifndef _PEI_VARIABLE_H

 #define _PEI_VARIABLE_H

diff --git a/MdeModulePkg/Universal/Variable/Pei/VariableWorker.c b/MdeModulePkg/Universal/Variable/Pei/VariableWorker.c
index 5ed326c54c..7b6d32132a 100644
--- a/MdeModulePkg/Universal/Variable/Pei/VariableWorker.c
+++ b/MdeModulePkg/Universal/Variable/Pei/VariableWorker.c
@@ -1,6 +1,8 @@
-/*++

+/** @file

 

-Copyright (c) 2007, Intel Corporation

+  Variable worker functions specific for IA32, X64 and EBC.

+

+Copyright (c) 2007 - 2008, 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

@@ -9,15 +11,7 @@ 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.

 

-Module Name:

-

-  VariableWorker.c

-

-Abstract:

-

-  PEIM to provide the Variable functionality

-

---*/

+**/

 

 #include <Variable.h>

 

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
index 9f6a9acd50..2571167d89 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
@@ -1,14 +1,16 @@
 /** @file

-  EFI Runtime Variable services.

+

+  Implement all four UEFI Runtime Variable services for the nonvolatile

+  and volatile storage space and install variable architecture protocol.

   

-  Copyright (c) 2006 - 2008, 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                                            

-

-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

+Copyright (c) 2006 - 2008, 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                                            

+

+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

 

 **/

 

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h
index f8a4e058f5..1fb430e206 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h
@@ -1,6 +1,9 @@
-/*++

+/** @file

 

-Copyright (c) 2006 - 2007, Intel Corporation

+  The internal header file includes the common header files, defines

+  internal structure and functions used by RuntimeVariable module.

+

+Copyright (c) 2006 - 2008, 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

@@ -9,13 +12,7 @@ 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.

 

-Module Name:

-

-  Variable.h

-

-Abstract:

-

---*/

+**/

 

 #ifndef _VARIABLE_H

 #define _VARIABLE_H

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/reclaim.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/reclaim.c
index dd43493f3e..a235ba09f8 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/reclaim.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/reclaim.c
@@ -1,6 +1,9 @@
-/*++

+/** @file

+  

+  Handles non-volatile variable store garbage collection, using FTW

+  (Fault Tolerant Write) protocol.

 

-Copyright (c) 2006 - 2007, Intel Corporation

+Copyright (c) 2006 - 2008, 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

@@ -9,18 +12,7 @@ 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.

 

-Module Name:

-

-  reclaim.c

-

-Abstract:

-

-  Handles non-volatile variable store garbage collection, using FTW

-  (Fault Tolerant Write) protocol.

-

-Revision History

-

---*/

+**/

 

 

 #include "Variable.h"

diff --git a/MdeModulePkg/Universal/WatchdogTimerDxe/WatchdogTimer.c b/MdeModulePkg/Universal/WatchdogTimerDxe/WatchdogTimer.c
index 7762933e59..2c7576c1e6 100644
--- a/MdeModulePkg/Universal/WatchdogTimerDxe/WatchdogTimer.c
+++ b/MdeModulePkg/Universal/WatchdogTimerDxe/WatchdogTimer.c
@@ -1,6 +1,9 @@
-/*++

-

-Copyright (c) 2006, Intel Corporation

+/** @file

+  

+  Generic watchdog timer services implemenetation using UEFI APIs and

+  install watchdog timer architecture protocol.

+  

+Copyright (c) 2006 - 2008, 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

@@ -9,17 +12,7 @@ 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.

 

-Module Name:

-

-  WatchdogTimer.c

-

-Abstract:

-

- Generic watchdog timer implemenetation using EFI APIs

-

-Revision History

-

---*/

+**/

 

 #include "WatchdogTimer.h"

 

diff --git a/MdeModulePkg/Universal/WatchdogTimerDxe/WatchdogTimer.h b/MdeModulePkg/Universal/WatchdogTimerDxe/WatchdogTimer.h
index ec6deec47a..0117d287bb 100644
--- a/MdeModulePkg/Universal/WatchdogTimerDxe/WatchdogTimer.h
+++ b/MdeModulePkg/Universal/WatchdogTimerDxe/WatchdogTimer.h
@@ -1,6 +1,9 @@
-/*++

+/** @file

 

-Copyright (c) 2006, Intel Corporation                                                         

+  The internal header file includes the common header files, defines

+  internal functions used by WatchDogTimer module.  

+

+Copyright (c) 2006 - 2008, 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        

@@ -9,17 +12,7 @@ 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.             

 

-Module Name:

-

-  WatchdogTimer.h

-

-Abstract:

-

- Generic watchdog timer implemenetation using EFI APIs

-

-Revision History

-

---*/

+**/

 

 #ifndef _WATCHDOG_TIMER_H_

 #define _WATCHDOG_TIMER_H_