Update TcgPei and TrEEPei driver to make gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreMax...

[mirror_edk2.git] / EdkCompatibilityPkg / Compatibility / FrameworkHiiOnUefiHiiThunk / HiiHandle.h

diff --git a/EdkCompatibilityPkg/Compatibility/FrameworkHiiOnUefiHiiThunk/HiiHandle.h b/EdkCompatibilityPkg/Compatibility/FrameworkHiiOnUefiHiiThunk/HiiHandle.h
index ed2b186b7dbd4bb5d07a84c84aa04f64cef685ff..6e36dae930b88d0ec9ce2d8b1c0587740ec6441e 100644 (file)
--- a/EdkCompatibilityPkg/Compatibility/FrameworkHiiOnUefiHiiThunk/HiiHandle.h
+++ b/EdkCompatibilityPkg/Compatibility/FrameworkHiiOnUefiHiiThunk/HiiHandle.h
@@ -1,8 +1,8 @@
-/**@file\r
+/** @file\r
   This file is for functins related to assign and free Framework HII handle number.\r
   \r
-Copyright (c) 2006 - 2008, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
 http://opensource.org/licenses/bsd-license.php\r
@@ -12,28 +12,48 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
-#ifndef _HII_HANDLE_H\r
-#define _HII_HANDLE_H\r
+#ifndef _HII_HANDLE_H_\r
+#define _HII_HANDLE_H_\r
 \r
 #include <FrameworkDxe.h>\r
 #include <Protocol/FrameworkHii.h>\r
 #include <Library/DebugLib.h>\r
 \r
+/**\r
+\r
+  Initialize the Framework Hii Handle database.\r
+\r
+**/\r
 VOID\r
 InitHiiHandleDatabase (\r
   VOID\r
   );\r
 \r
+/**\r
+  Allocate a new Framework HII handle. \r
+\r
+  @param  Handle Returns the new Framework HII Handle assigned.\r
+\r
+  @retval EFI_SUCCESS         A new Framework HII Handle is assigned.\r
+  @retval EFI_OUT_OF_RESOURCE The Framework HII Handle database is depleted.\r
+\r
+**/\r
 EFI_STATUS\r
 AllocateHiiHandle (\r
-  FRAMEWORK_EFI_HII_HANDLE *Handle\r
-);\r
+  OUT FRAMEWORK_EFI_HII_HANDLE *Handle\r
+  );\r
   \r
 \r
+/**\r
+  Free Framework HII handle. \r
+\r
+  @param  Handle The Framework HII Handle to be freed.\r
+\r
+**/\r
 VOID\r
 FreeHiiHandle (\r
-  FRAMEWORK_EFI_HII_HANDLE Handle\r
-);\r
+  IN FRAMEWORK_EFI_HII_HANDLE Handle\r
+  );\r
 \r
 \r
 #endif\r