Code scrube for MdeModule Definitions.

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

17 files changed, 64 insertions, 93 deletions

diff --git a/MdeModulePkg/Include/Guid/AlternateFvBlock.h b/MdeModulePkg/Include/Guid/AlternateFvBlock.h
index 4ea8a2143d..8731fe862b 100644
--- a/MdeModulePkg/Include/Guid/AlternateFvBlock.h
+++ b/MdeModulePkg/Include/Guid/AlternateFvBlock.h
@@ -1,6 +1,7 @@
 /** @file

 

-  Tiano Guid used to define the Alternate Firmware Volume Block Guid.

+  This file defines the Alternate Firmware Volume Block Guid, which is 

+  used to specify that the additional FVB protocol is installed into FVB handle.

 

 Copyright (c) 2006 - 2008, Intel Corporation

 All rights reserved. This program and the accompanying materials

diff --git a/MdeModulePkg/Include/Guid/Bmp.h b/MdeModulePkg/Include/Guid/Bmp.h
index 3f9c3999b4..8a081d8a9c 100644
--- a/MdeModulePkg/Include/Guid/Bmp.h
+++ b/MdeModulePkg/Include/Guid/Bmp.h
@@ -1,6 +1,6 @@
 /** @file

   This file defines header data structures for BMP file and default

-  BMP file GUID. 

+  GUID for BMP logo file. 

 

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

 All rights reserved. This program and the accompanying materials

diff --git a/MdeModulePkg/Include/Guid/CapsuleVendor.h b/MdeModulePkg/Include/Guid/CapsuleVendor.h
index 118e08b5b1..6e7d8d1e92 100644
--- a/MdeModulePkg/Include/Guid/CapsuleVendor.h
+++ b/MdeModulePkg/Include/Guid/CapsuleVendor.h
@@ -1,6 +1,7 @@
 /** @file

 

-  Capsule update Guid definitions for capsule varialbe and capsule hob.

+  This file defines capsule update guid, capsule variable name and 

+  capsule guid hob data strucutre, which are required by capsule update feature.

 

 Copyright (c) 2006 - 2008, Intel Corporation

 All rights reserved. This program and the accompanying materials

@@ -17,7 +18,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define __EFI_CAPSULE_VENDOR_GUID_H__

 

 //

-// Note -- This guid is used as a vendor GUID (depending on implementation)

+// Note -- This guid is used as a variable GUID (depending on implementation)

 // for the capsule variable if the capsule pointer is passes through reset

 // via a variable.

 //

diff --git a/MdeModulePkg/Include/Guid/ConsoleInDevice.h b/MdeModulePkg/Include/Guid/ConsoleInDevice.h
index 85e487d0e1..34ee24d73b 100644
--- a/MdeModulePkg/Include/Guid/ConsoleInDevice.h
+++ b/MdeModulePkg/Include/Guid/ConsoleInDevice.h
@@ -1,6 +1,9 @@
-/*++

+/** @file

+  This guid is used to specifiy the device is the console in device.

+  If the device is the console in device, this guid as the protocol guid

+  will be installed into this device handle.

 

-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,14 +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:

-

-  ConsoleInDevice.h

-

-Abstract:

-

-

---*/

+**/

 

 #ifndef __CONSOLE_IN_DEVICE_H__

 #define __CONSOLE_IN_DEVICE_H__

diff --git a/MdeModulePkg/Include/Guid/ConsoleOutDevice.h b/MdeModulePkg/Include/Guid/ConsoleOutDevice.h
index d2103c0e5d..42dccd7a54 100644
--- a/MdeModulePkg/Include/Guid/ConsoleOutDevice.h
+++ b/MdeModulePkg/Include/Guid/ConsoleOutDevice.h
@@ -1,6 +1,9 @@
-/*++

+/** @file

+  This guid is used to specifiy the device is the console out device.

+  If the device is the console out device, this guid as the protocol guid

+  will be installed into this device handle.

 

-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,14 +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:

-

-  ConsoleOutDevice.h

-

-Abstract:

-

-

---*/

+**/

 

 #ifndef __CONSOLE_OUT_DEVICE_H__

 #define __CONSOLE_OUT_DEVICE_H__

diff --git a/MdeModulePkg/Include/Guid/GenericPlatformVariable.h b/MdeModulePkg/Include/Guid/GenericPlatformVariable.h
index cd1e66f2df..92c73234f0 100644
--- a/MdeModulePkg/Include/Guid/GenericPlatformVariable.h
+++ b/MdeModulePkg/Include/Guid/GenericPlatformVariable.h
@@ -1,5 +1,7 @@
 /** @file

-  The variable space Guid to pair with a Unicode string name to tag an EFI variable.

+  This file defines the genenic platform guid for EFI variable.

+  Common drivers can use this generic guid with its variable name to specify 

+  its EFI variable without defining another new guid.

 

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

 All rights reserved. This program and the accompanying materials

@@ -15,6 +17,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #ifndef __GENERIC_PLATFORM_VARIABLE_H__

 #define __GENERIC_PLATFORM_VARIABLE_H__

 

+#define EFI_GENERIC_PLATFORM_VARIABLE_GUID  \

+  { 0x59d1c24f, 0x50f1, 0x401a, { 0xb1, 0x01, 0xf3, 0x3e, 0x0d, 0xae, 0xd4, 0x43 }}

+

 extern EFI_GUID gEfiGenericPlatformVariableGuid;

 

 #endif

diff --git a/MdeModulePkg/Include/Guid/HotPlugDevice.h b/MdeModulePkg/Include/Guid/HotPlugDevice.h
index b15dc89bbd..2a18ad6abc 100644
--- a/MdeModulePkg/Include/Guid/HotPlugDevice.h
+++ b/MdeModulePkg/Include/Guid/HotPlugDevice.h
@@ -1,6 +1,9 @@
-/*++

+/** @file

+  This guid is used to specifiy the device is the hot plug device.

+  If the device is the hot plug device, this guid as the protocol guid

+  will be installed into this device handle.

 

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

-

-  HotPlugDevice.h

-

-Abstract:

-

-

---*/

+**/

 

 #ifndef __HOT_PLUG_DEVICE_H__

 #define __HOT_PLUG_DEVICE_H__

diff --git a/MdeModulePkg/Include/Guid/MemoryTypeInformation.h b/MdeModulePkg/Include/Guid/MemoryTypeInformation.h
index 02794cab73..7d88d628fe 100644
--- a/MdeModulePkg/Include/Guid/MemoryTypeInformation.h
+++ b/MdeModulePkg/Include/Guid/MemoryTypeInformation.h
@@ -1,5 +1,6 @@
 /** @file

-  GUID used for Memory Type Information entries in the HOB list.

+  This file defines the memory type information guid, variable name and guid hob structure. 

+  This guid is used for Memory Type Information entries in the HOB list and EFI variable.

 

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

 All rights reserved. This program and the accompanying materials

diff --git a/MdeModulePkg/Include/Guid/OverrideVariable.h b/MdeModulePkg/Include/Guid/OverrideVariable.h
index 673813a580..ecfd94f182 100644
--- a/MdeModulePkg/Include/Guid/OverrideVariable.h
+++ b/MdeModulePkg/Include/Guid/OverrideVariable.h
@@ -1,4 +1,5 @@
-/*++

+/** @file

+  This guid is used for Platform Override Variable named L"PlatDriOver".

 

 Copyright (c) 2008, Intel Corporation

 All rights reserved. This program and the accompanying materials

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

-

-  OverrideVariable.h

-

-Abstract:

-

-  Platform Override Variable Guid definitions

-

---*/

+**/

 

 #ifndef __EFI_OVERRIDE_VARIABLE_GUID_H__

 #define __EFI_OVERRIDE_VARIABLE_GUID_H__

diff --git a/MdeModulePkg/Include/Guid/PeiPeCoffLoader.h b/MdeModulePkg/Include/Guid/PeiPeCoffLoader.h
index eaca8e6f23..22567d0066 100644
--- a/MdeModulePkg/Include/Guid/PeiPeCoffLoader.h
+++ b/MdeModulePkg/Include/Guid/PeiPeCoffLoader.h
@@ -1,6 +1,6 @@
 /** @file

-  

-  GUID for the PE/COFF Loader APIs shared between SEC, PEI and DXE

+  This file defines PeCoffLoader guid for PeCoffLoader entry in the HOB list.

+  It also defines PE/COFF Loader APIs in PeCoffLoader Hob entry shared between SEC, PEI and DXE

 

 Copyright (c) 2006 - 2008, Intel Corporation                                                         

 All rights reserved. This program and the accompanying materials                          

@@ -128,7 +128,7 @@ RETURN_STATUS
 typedef 

 RETURN_STATUS

 (EFIAPI *EFI_PEI_PE_COFF_LOADER_UNLOAD_IMAGE) (

-  IN EFI_PEI_PE_COFF_LOADER_PROTOCOL          *This,

+  IN EFI_PEI_PE_COFF_LOADER_PROTOCOL      *This,

   IN PE_COFF_LOADER_IMAGE_CONTEXT         *ImageContext

   );

 

diff --git a/MdeModulePkg/Include/Guid/PeiPerformanceHob.h b/MdeModulePkg/Include/Guid/PeiPerformanceHob.h
index b072127e90..4cc82e8678 100644
--- a/MdeModulePkg/Include/Guid/PeiPerformanceHob.h
+++ b/MdeModulePkg/Include/Guid/PeiPerformanceHob.h
@@ -1,5 +1,6 @@
 /** @file

-  GUIDs used for PEI Performance HOB data structures

+  This file defines performance guid for the performance entry in the HOB list, 

+  and define the PEI Performance HOB data structures.

 

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

 All rights reserved. This program and the accompanying materials

diff --git a/MdeModulePkg/Include/Guid/PrimaryConsoleInDevice.h b/MdeModulePkg/Include/Guid/PrimaryConsoleInDevice.h
index 686ffa333c..1471a53a47 100644
--- a/MdeModulePkg/Include/Guid/PrimaryConsoleInDevice.h
+++ b/MdeModulePkg/Include/Guid/PrimaryConsoleInDevice.h
@@ -1,6 +1,8 @@
-/*++

+/** @file

+  This guid is used to specify the primary console in device.

+  It will be installed into the virtual device handle for ConIn Splitter.

 

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

-

-  PrimaryConsoleInDevice.h

-

-Abstract:

-

-

---*/

+**/

 

 #ifndef __PRIMARY_CONSOLE_IN_DEVICE_H__

 #define __PRIMARY_CONSOLE_IN_DEVICE_H__

diff --git a/MdeModulePkg/Include/Guid/PrimaryConsoleOutDevice.h b/MdeModulePkg/Include/Guid/PrimaryConsoleOutDevice.h
index 34195b5219..67be727ab1 100644
--- a/MdeModulePkg/Include/Guid/PrimaryConsoleOutDevice.h
+++ b/MdeModulePkg/Include/Guid/PrimaryConsoleOutDevice.h
@@ -1,6 +1,8 @@
-/*++

+/** @file

+  This guid is used to specify the primary console out device.

+  It will be installed into the virtual device handle for ConOut Splitter.

 

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

-

-  PrimaryConsoleOutDevice.h

-

-Abstract:

-

---*/

+**/

 

 #ifndef __PRIMARY_CONSOLE_OUT_DEVICE_H__

 #define __PRIMARY_CONSOLE_OUT_DEVICE_H__

diff --git a/MdeModulePkg/Include/Guid/PrimaryStandardErrorDevice.h b/MdeModulePkg/Include/Guid/PrimaryStandardErrorDevice.h
index 9523d97ac3..50031535e1 100644
--- a/MdeModulePkg/Include/Guid/PrimaryStandardErrorDevice.h
+++ b/MdeModulePkg/Include/Guid/PrimaryStandardErrorDevice.h
@@ -1,6 +1,8 @@
-/*++

+/** @file

+  This guid is used to specify the primary StdErr device.

+  It will be installed into the virtual device handle for StdErr Splitter.

 

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

-

-  PrimaryStandardErrorDevice.h

-

-Abstract:

-

---*/

+**/

 

 #ifndef __PRIMARY_STANDARD_ERROR_DEVICE_H__

 #define __PRIMARY_STANDARD_ERROR_DEVICE_H__

diff --git a/MdeModulePkg/Include/Guid/StandardErrorDevice.h b/MdeModulePkg/Include/Guid/StandardErrorDevice.h
index 7806f55d3b..bacfefe051 100644
--- a/MdeModulePkg/Include/Guid/StandardErrorDevice.h
+++ b/MdeModulePkg/Include/Guid/StandardErrorDevice.h
@@ -1,6 +1,9 @@
-/*++

+/** @file

+  This guid is used to specifiy the device is the StdErr device.

+  If the device is the StdErr device, this guid as the protocol guid

+  will be installed into this device handle.

 

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

-

-  StandardErrorDevice.h

-

-Abstract:

-

-

---*/

+**/

 

 #ifndef __STANDARD_ERROR_DEVICE_H__

 #define __STANDARD_ERROR_DEVICE_H__

diff --git a/MdeModulePkg/Include/Guid/SystemNvDataGuid.h b/MdeModulePkg/Include/Guid/SystemNvDataGuid.h
index fd807f93a2..137ed230a1 100644
--- a/MdeModulePkg/Include/Guid/SystemNvDataGuid.h
+++ b/MdeModulePkg/Include/Guid/SystemNvDataGuid.h
@@ -1,7 +1,6 @@
 /** @file

-

-  GUIDs used for System Non Volatile HOB entries in the in the HOB list and FV Guids carrying

-  the System specific information.

+  This file defines GUIDs used for System Non Volatile HOB entries in the HOB list,

+  and FV Guids that carrying the System specific information.

 

 Copyright (c) 2006 - 2008, Intel Corporation                                                         

 All rights reserved. This program and the accompanying materials                          

diff --git a/MdeModulePkg/Include/Guid/VariableInfo.h b/MdeModulePkg/Include/Guid/VariableInfo.h
index a7e624d90f..e63224fd5b 100644
--- a/MdeModulePkg/Include/Guid/VariableInfo.h
+++ b/MdeModulePkg/Include/Guid/VariableInfo.h
@@ -1,6 +1,5 @@
 /** @file

-

-  GUIDs used for variable list entries put in the EFI system table.

+  This file defines GUIDs used for variable list entries put in the EFI system table.

 

 Copyright (c) 2006 - 2008, Intel Corporation

 All rights reserved. This program and the accompanying materials