Correct all header files for doxygen format and correct the license issue for VgaClass driver.

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

9 files changed, 42 insertions, 112 deletions

diff --git a/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h b/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
index d5496483b5..88774dbdfb 100644
--- a/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
+++ b/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
@@ -1,5 +1,7 @@
-/*++

-

+/**@file

+  GUID used to identify Data Hub records that originate from the Tiano 

+  ReportStatusCode API.

+  

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

@@ -9,16 +11,8 @@ 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:

-

-  StatusCode.h

-    

-Abstract:

-

-  GUID used to identify Data Hub records that originate from the Tiano 

-  ReportStatusCode API.

+**/

 

---*/

 

 #ifndef __STATUS_CODE_H__

 #define __STATUS_CODE_H__

diff --git a/IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h b/IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h
index fb80d1954b..7a6bd06d10 100644
--- a/IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h
+++ b/IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h
@@ -1,5 +1,6 @@
-/*++

-

+/**@file

+  GUID used to identify status code records HOB that originate from the PEI status code    

+  

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

@@ -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:

-

-  MemoryStatusCodeRecord.h

-    

-Abstract:

-

-  GUID used to identify status code records HOB that originate from the PEI status code  

-

---*/

+**/

 

 #ifndef __MEMORY_STATUS_CODE_RECORD_H__

 #define __MEMORY_STATUS_CODE_RECORD_H__

diff --git a/IntelFrameworkModulePkg/Include/Guid/PciHotplugDevice.h b/IntelFrameworkModulePkg/Include/Guid/PciHotplugDevice.h
index 3d750cb854..197a0465b7 100644
--- a/IntelFrameworkModulePkg/Include/Guid/PciHotplugDevice.h
+++ b/IntelFrameworkModulePkg/Include/Guid/PciHotplugDevice.h
@@ -1,5 +1,6 @@
-/*++

-

+/**@file

+  GUIDs used to indicate the device is Pccard hotplug device

+  

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

@@ -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:

-  

-    PciHotplugDevice.h

-    

-Abstract:

-

-  GUIDs used to indicate the device is Pccard hotplug device

-  

---*/

+**/

 

 #ifndef __PCI_HOTPLUG_DEVICE_GUID_H_

 #define __PCI_HOTPLUG_DEVICE_GUID_H_

diff --git a/IntelFrameworkModulePkg/Include/Guid/PciOptionRomTable.h b/IntelFrameworkModulePkg/Include/Guid/PciOptionRomTable.h
index 0ba44dbed4..ef9e345de5 100644
--- a/IntelFrameworkModulePkg/Include/Guid/PciOptionRomTable.h
+++ b/IntelFrameworkModulePkg/Include/Guid/PciOptionRomTable.h
@@ -1,5 +1,6 @@
-/*++

-

+/**@file

+  GUID and data structure used to describe the list of PCI Option ROMs present in a system.

+  

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

@@ -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:

-

-  PciOptionRomTable.h

-    

-Abstract:

-

-  GUID and data structure used to describe the list of PCI Option ROMs present in a system.

-

---*/

+**/

 

 #ifndef __PCI_OPTION_ROM_TABLE_GUID_H_

 #define __PCI_OPTION_ROM_TABLE_GUID_H_

diff --git a/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h b/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h
index 8e7402d667..c609ca4d15 100644
--- a/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h
+++ b/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h
@@ -1,6 +1,7 @@
-/*++

+/**@file

+  EFI ISA Acpi Protocol

 

-Copyright (c) 2006, Intel Corporation                                                         

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

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

-

-    IsaAcpi.h

-    

-Abstract:

-

-    EFI ISA Acpi Protocol

-

-Revision History

-

---*/

+**/

 

 #ifndef __ISA_ACPI_H_

 #define __ISA_ACPI_H_

diff --git a/IntelFrameworkModulePkg/Include/Protocol/IsaIo.h b/IntelFrameworkModulePkg/Include/Protocol/IsaIo.h
index 09ac260572..4628710fef 100644
--- a/IntelFrameworkModulePkg/Include/Protocol/IsaIo.h
+++ b/IntelFrameworkModulePkg/Include/Protocol/IsaIo.h
@@ -1,4 +1,5 @@
-/*++

+/**@file

+  EFI ISA I/O Protocol

 

 Copyright (c) 2006 - 2007, Intel Corporation                                                         

 All rights reserved. This program and the accompanying materials                          

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

-

-    IsaIo.h

-    

-Abstract:

-

-    EFI ISA I/O Protocol

-

-Revision History

-

---*/

+**/

 

 #ifndef _EFI_ISA_IO_H

 #define _EFI_ISA_IO_H

diff --git a/IntelFrameworkModulePkg/Include/Protocol/PciHotPlugRequest.h b/IntelFrameworkModulePkg/Include/Protocol/PciHotPlugRequest.h
index 0aa641e3c0..17e5a65f8a 100644
--- a/IntelFrameworkModulePkg/Include/Protocol/PciHotPlugRequest.h
+++ b/IntelFrameworkModulePkg/Include/Protocol/PciHotPlugRequest.h
@@ -1,6 +1,6 @@
-/*++

+/**@file

 

-Copyright (c) 2006, Intel Corporation                                                         

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

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

-

-  PciHotPlugRequest.h

-

-Abstract:

-

-  

- 

---*/

+**/

 

 #ifndef __PCI_HOTPLUG_REQUEST_H_

 #define __PCI_HOTPLUG_REQUEST_H_

diff --git a/IntelFrameworkModulePkg/Include/Protocol/Ps2Policy.h b/IntelFrameworkModulePkg/Include/Protocol/Ps2Policy.h
index 56a007ac0d..757d21f69f 100644
--- a/IntelFrameworkModulePkg/Include/Protocol/Ps2Policy.h
+++ b/IntelFrameworkModulePkg/Include/Protocol/Ps2Policy.h
@@ -1,24 +1,17 @@
-/*++

-

-Copyright (c) 2006, Intel Corporation. All rights reserved. 

-This software and associated documentation (if any) is furnished

-under a license and may only be used or copied in accordance

-with the terms of the license. Except as permitted by such

-license, no part of this software or documentation may be

-reproduced, stored in a retrieval system, or transmitted in any

-form or by any means without the express written consent of

-Intel Corporation.

-

-

-Module Name:

+/**@file

+  Protocol used for PS/2 Policy definition.

 

-  Ps2Policy.h

-    

-Abstract:

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

+                                                                                          

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

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

 

-  Protocol used for PS/2 Policy definition.

+**/

 

---*/

 

 #ifndef _PS2_POLICY_PROTOCOL_H_

 #define _PS2_POLICY_PROTOCOL_H_

diff --git a/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h b/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h
index b20a3afb4d..bb9802420c 100644
--- a/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h
+++ b/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h
@@ -1,6 +1,7 @@
-/*++

+/**@file

+  Vga Mini port binding for a VGA controller

 

-Copyright (c) 2006, Intel Corporation                                                         

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

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

-

-    VgaMiniPort.h

-    

-Abstract:

-

-    Vga Mini port binding for a VGA controller

-

-Revision History

-

---*/

+**/

 

 #ifndef __VGA_MINI_PORT_H_

 #define __VGA_MINI_PORT_H_