Add more comments for IntelFramework's header files.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Library / FrameworkIfrSupportLib.h

diff --git a/IntelFrameworkPkg/Include/Library/FrameworkIfrSupportLib.h b/IntelFrameworkPkg/Include/Library/FrameworkIfrSupportLib.h
index d2a1ff5ee4180b20e2106d16088b60bee399f98d..a062f87177c78e554b23f6ece946a346b1233163 100644 (file)
--- a/IntelFrameworkPkg/Include/Library/FrameworkIfrSupportLib.h
+++ b/IntelFrameworkPkg/Include/Library/FrameworkIfrSupportLib.h
@@ -1,5 +1,9 @@
-/*++\r
+/** @file\r
+  Library class name: FrameworkIfrSupportLib\r

 \r
 \r

+  FrameworkIfrSupportLib is designed for produce IFR operation interface .\r
+  The IFR format follows framework specification.\r
+  \r

 Copyright (c) 2006, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
 are licensed and made available under the terms and conditions of the BSD License         \r
 Copyright (c) 2006, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
 are licensed and made available under the terms and conditions of the BSD License         \r


@@ -9,15 +13,7 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r

-Module Name:\r
-\r
-  IfrSupportLib.h\r
-\r
-Abstract:\r
-\r
-  The file contain all library function for Ifr Operations.\r
-\r
---*/\r
+**/\r

 \r
 #ifndef _IFRSUPPORTLIBRARY_H\r
 #define _IFRSUPPORTLIBRARY_H\r
 \r
 #ifndef _IFRSUPPORTLIBRARY_H\r
 #define _IFRSUPPORTLIBRARY_H\r


@@ -513,7 +509,7 @@ Returns:
 \r
 EFI_STATUS\r
 ExtractDataFromHiiHandle (\r
 \r
 EFI_STATUS\r
 ExtractDataFromHiiHandle (\r

-  IN      EFI_HII_HANDLE      HiiHandle,\r
+  IN      FRAMEWORK_EFI_HII_HANDLE       HiiHandle,\r

   IN OUT  UINT16              *ImageLength,\r
   OUT     UINT8               *DefaultImage,\r
   OUT     EFI_GUID            *Guid\r
   IN OUT  UINT16              *ImageLength,\r
   OUT     UINT8               *DefaultImage,\r
   OUT     EFI_GUID            *Guid\r


@@ -547,7 +543,7 @@ Returns:
 --*/\r
 ;\r
 \r
 --*/\r
 ;\r
 \r

-EFI_HII_HANDLE\r
+FRAMEWORK_EFI_HII_HANDLE \r

 FindHiiHandle (\r
   IN OUT EFI_HII_PROTOCOL    **HiiProtocol, OPTIONAL\r
   IN     EFI_GUID            *Guid\r
 FindHiiHandle (\r
   IN OUT EFI_HII_PROTOCOL    **HiiProtocol, OPTIONAL\r
   IN     EFI_GUID            *Guid\r


@@ -917,7 +913,7 @@ Returns:
 \r
 EFI_STATUS\r
 ValidateDataFromHiiHandle (\r
 \r
 EFI_STATUS\r
 ValidateDataFromHiiHandle (\r

-  IN      EFI_HII_HANDLE      HiiHandle,\r
+  IN      FRAMEWORK_EFI_HII_HANDLE       HiiHandle,\r

   OUT     BOOLEAN             *Results\r
   )\r
 /*++\r
   OUT     BOOLEAN             *Results\r
   )\r
 /*++\r