Correct the structure's comments to follow doxygen format.

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

diff --git a/IntelFrameworkPkg/Include/Protocol/FrameworkFormBrowser.h b/IntelFrameworkPkg/Include/Protocol/FrameworkFormBrowser.h
index 14cd53f4d501bc2f6ca86ed08c4534560ebb18fe..db3809a6bb2b642ab7f7c1dfa227a357e22d6d22 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/FrameworkFormBrowser.h
+++ b/IntelFrameworkPkg/Include/Protocol/FrameworkFormBrowser.h
@@ -5,7 +5,7 @@
   in 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
@@ -32,6 +32,11 @@
     0xe5a1333e, 0xe1b4, 0x4d55, {0xce, 0xeb, 0x35, 0xc3, 0xef, 0x13, 0x34, 0x43 } \\r
   }\r
 \r
+#define EFI_FORM_BROWSER_COMPATIBILITY_PROTOCOL_GUID \\r
+  { \\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
 \r
 typedef struct {\r
@@ -50,7 +55,7 @@ typedef struct {
   UINTN RightColumn;\r
   UINTN TopRow;\r
   UINTN BottomRow;\r
-} EFI_SCREEN_DESCRIPTOR;\r
+} FRAMEWORK_EFI_SCREEN_DESCRIPTOR;\r
 \r
 /**\r
   Provides direction to the configuration driver whether to use the HII\r
@@ -91,15 +96,15 @@ typedef struct {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SEND_FORM) (\r
+(EFIAPI *EFI_SEND_FORM)(\r
   IN  EFI_FORM_BROWSER_PROTOCOL       *This,\r
   IN  BOOLEAN                         UseDatabase,\r
   IN  FRAMEWORK_EFI_HII_HANDLE        *Handle,\r
   IN  UINTN                           HandleCount,\r
-  IN  FRAMEWORK_EFI_IFR_PACKET                  *Packet, OPTIONAL\r
+  IN  FRAMEWORK_EFI_IFR_PACKET        *Packet, OPTIONAL\r
   IN  EFI_HANDLE                      CallbackHandle, OPTIONAL\r
   IN  UINT8                           *NvMapOverride, OPTIONAL\r
-  IN EFI_SCREEN_DESCRIPTOR            *ScreenDimensions, OPTIONAL\r
+  IN  FRAMEWORK_EFI_SCREEN_DESCRIPTOR *ScreenDimensions, OPTIONAL\r
   OUT BOOLEAN                         *ResetRequired OPTIONAL\r
   );\r
 \r
@@ -127,7 +132,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_CREATE_POP_UP) (\r
+(EFIAPI *EFI_CREATE_POP_UP)(\r
   IN  UINTN                           NumberOfLines,\r
   IN  BOOLEAN                         HotKey,\r
   IN  UINTN                           MaximumStringSize,\r
@@ -138,25 +143,26 @@ 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 functions 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
 extern EFI_GUID gEfiFormBrowserProtocolGuid;\r
+extern EFI_GUID gEfiFormBrowserCompatibilityProtocolGuid;\r
+\r
 \r
 #endif\r