Move SmmLib from IntelFrameworkPkg to MdePkg because this library is useful to both...

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / FrameworkFormBrowser.h

diff --git a/IntelFrameworkPkg/Include/Protocol/FrameworkFormBrowser.h b/IntelFrameworkPkg/Include/Protocol/FrameworkFormBrowser.h
index 9f7743156249b3bb3ffb70b6c70803898e05f961..4aa3dd1acbb13b3aa9a075e0854406c9a9880e27 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/FrameworkFormBrowser.h
+++ b/IntelFrameworkPkg/Include/Protocol/FrameworkFormBrowser.h
@@ -1,11 +1,11 @@
 /** @file\r
   The EFI_FORM_BROWSER_PROTOCOL is the interface to the EFI\r
-  Configuration Driver.  This will allow the caller to direct the\r
-  configuration driver to use either the HII database or use the passed\r
-  in packet of data.  This will also allow the caller to post messages\r
+  Configuration Driver.  This interface enables the caller to direct the\r
+  configuration driver to use either the HII database or the passed-in\r
+  packet of data.  This will also allow the caller to post messages\r
   into the configuration drivers internal mailbox.\r
 \r
-  Copyright (c) 2006, Intel Corporation\r
+  Copyright (c) 2006 - 2009, 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
   which accompanies this distribution.  The full text of the license may be found at\r
@@ -34,7 +34,7 @@
 \r
 #define EFI_FORM_BROWSER_COMPATIBILITY_PROTOCOL_GUID \\r
   { \\r
-    0xe5a1333e, 0xe1b4, 0x4d55, {0xce, 0xeb, 0x35, 0xc3, 0xef, 0x13, 0x34, 0x43 } \\r
+    0xfb7c852, 0xadca, 0x4853, { 0x8d, 0xf, 0xfb, 0xa7, 0x1b, 0x1c, 0xe1, 0x1a } \\r
   }\r
 \r
 typedef struct _EFI_FORM_BROWSER_PROTOCOL EFI_FORM_BROWSER_PROTOCOL;\r
@@ -48,7 +48,7 @@ typedef struct {
 typedef struct {\r
   EFI_HII_IFR_PACK    *IfrData;\r
   EFI_HII_STRING_PACK *StringData;\r
-} FRAMEWORK_EFI_IFR_PACKET;\r
+} EFI_IFR_PACKET;\r
 \r
 typedef struct {\r
   UINTN LeftColumn;\r
@@ -81,7 +81,7 @@ typedef struct {
   @param  ScreenDimensions      Allows the browser to be called so that it occupies\r
                                 a portion of the physical screen instead of dynamically determining the\r
                                 screen dimensions.\r
-  @param  ResetRequired         This BOOLEAN value will tell the caller if a reset\r
+  @param  ResetRequired         This BOOLEAN value denotes whether a reset\r
                                 is required based on the data that might have been changed. The ResetRequired\r
                                 parameter is primarily applicable for configuration applications, and is an\r
                                 optional parameter.\r
@@ -101,10 +101,10 @@ EFI_STATUS
   IN  BOOLEAN                         UseDatabase,\r
   IN  FRAMEWORK_EFI_HII_HANDLE        *Handle,\r
   IN  UINTN                           HandleCount,\r
-  IN  FRAMEWORK_EFI_IFR_PACKET                  *Packet, OPTIONAL\r
+  IN  EFI_IFR_PACKET                  *Packet, OPTIONAL\r
   IN  EFI_HANDLE                      CallbackHandle, OPTIONAL\r
   IN  UINT8                           *NvMapOverride, OPTIONAL\r
-  IN  FRAMEWORK_EFI_SCREEN_DESCRIPTOR            *ScreenDimensions, OPTIONAL\r
+  IN  FRAMEWORK_EFI_SCREEN_DESCRIPTOR *ScreenDimensions, OPTIONAL\r
   OUT BOOLEAN                         *ResetRequired OPTIONAL\r
   );\r
 \r
@@ -143,22 +143,21 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  @par Protocol Description:\r
   The EFI_FORM_BROWSER_PROTOCOL is the interface to call for drivers to\r
   leverage the EFI configuration driver interface.\r
-\r
-  @param SendForm\r
-  Provides direction to the configuration driver whether to use the HII\r
-  database or to use a passed-in set of data. This functions also establishes\r
-  a pointer to the calling driver's callback interface.\r
-\r
-  @param CreatePopUp\r
-  Routine used to abstract a generic dialog interface and return the\r
-  selected key or string.\r
-\r
 **/\r
 struct _EFI_FORM_BROWSER_PROTOCOL {\r
+  ///\r
+  /// Provides direction to the configuration driver whether to use the HII\r
+  /// database or to use a passed-in set of data. This function also establishes\r
+  /// a pointer to the calling driver's callback interface.\r
+  ///\r
   EFI_SEND_FORM     SendForm;\r
+  \r
+  ///\r
+  /// Routine used to abstract a generic dialog interface and return the\r
+  /// selected key or string.  \r
+  ///\r
   EFI_CREATE_POP_UP CreatePopUp;\r
 };\r
 \r