Update header file comments.

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

4 files changed, 20 insertions, 15 deletions

diff --git a/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h b/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
index c1cc82de2b..3439372853 100644
--- a/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
+++ b/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
@@ -1,7 +1,10 @@
 /** @file

-  Generic BDS library definition, include the data structure and function.

+  Generic BDS library defines general interfaces for BDS driver including:

+    1) BDS boot policy interface;

+    2) BDS boot device connect interface;

+    3) BDS Misc interfaces for mainting boot variable, ouput string.

 

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

+Copyright (c) 2004 - 2009, 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/IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h b/IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h
index 5f5726ea8a..da44d822d2 100644
--- a/IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h
+++ b/IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h
@@ -1,7 +1,8 @@
 /** @file

-  OEM hook status code library functions with no library constructor/destructor

+  OEM hook status code library. Platform can implement an instance to 

+  initialize the OEM devices to report status code information.

 

-  Copyright (c) 2006, Intel Corporation

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

diff --git a/IntelFrameworkModulePkg/Include/Library/PciIncompatibleDeviceSupportLib.h b/IntelFrameworkModulePkg/Include/Library/PciIncompatibleDeviceSupportLib.h
index e29b27c65f..a518991a79 100644
--- a/IntelFrameworkModulePkg/Include/Library/PciIncompatibleDeviceSupportLib.h
+++ b/IntelFrameworkModulePkg/Include/Library/PciIncompatibleDeviceSupportLib.h
@@ -1,7 +1,8 @@
 /** @file

-  PCI Incompatible device support Libary.

+  PCI Incompatible device support Libary. Platform can implement an 

+  instance to support the incompatible PCI devices.

 

-Copyright (c) 2006 - 2007, Intel Corporation                                                         

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

@@ -74,8 +75,8 @@ typedef struct {
   @param  PciDeviceInfo       A pointer to PCI device information.

   @param  Configuration       Returned information.

 

-  @retval returns EFI_SUCCESS if check incompatible device ok.

-          Otherwise return EFI_UNSUPPORTED.

+  @retval EFI_SUCCESS         The incompatible device is supported.

+  @retval EFI_UNSUPPORTED     The incompatible device is not supported.

 **/

 RETURN_STATUS

 EFIAPI

@@ -96,8 +97,8 @@ PciResourceUpdateCheck (
   @param  Offset              The address within the PCI configuration space.

   @param  Configuration       Returned information.

 

-  @retval returns EFI_SUCCESS if check incompatible device ok.

-          Otherwise return EFI_UNSUPPORTED.

+  @retval EFI_SUCCESS         The incompatible device is supported.

+  @retval EFI_UNSUPPORTED     The incompatible device is not supported.

 **/

 RETURN_STATUS

 EFIAPI

@@ -123,8 +124,8 @@ PciRegisterUpdateCheck (
   @param  AccessWidth         Access width needs to check incompatibility.

   @param  Configuration       Returned information.

 

-  @retval returns EFI_SUCCESS if check incompatible device ok.

-          Otherwise return EFI_UNSUPPORTED.

+  @retval EFI_SUCCESS         The incompatible device is supported.

+  @retval EFI_UNSUPPORTED     The incompatible device is not supported.

 **/

 RETURN_STATUS

 EFIAPI

diff --git a/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h b/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h
index 5a85deb5fe..2e4b0d86c8 100644
--- a/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h
+++ b/IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h
@@ -1,8 +1,8 @@
 /** @file

-  Platform BDS library definition. Platform package can provide hook library

-  instances to implement platform specific behavior.

+  Platform BDS library definition. Platform can implement an

+  instances to support the platform specific behavior.

 

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

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