Correct the structure's comments to follow doxygen format.

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

diff --git a/IntelFrameworkPkg/Include/Protocol/FrameworkFormCallback.h b/IntelFrameworkPkg/Include/Protocol/FrameworkFormCallback.h
index f44c90643f3586d39e9f9c69c0fa25b47207b496..e42459dd902f7953aeb581abb139359696a942e5 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/FrameworkFormCallback.h
+++ b/IntelFrameworkPkg/Include/Protocol/FrameworkFormCallback.h
@@ -5,7 +5,7 @@
   specific drivers which want to export access to custom hardware storage or\r
   publish IFR which has a requirement to call back the original driver.\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
@@ -183,27 +183,16 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  @par Protocol Description:\r
   The EFI_FORM_CALLBACK_PROTOCOL is the defined interface for access to\r
   custom NVS devices as well as communication of user selections in a more\r
   interactive environment. This protocol should be published by hardware-specific\r
   drivers that want to export access to custom hardware storage or publish IFR\r
   that has a requirement to call back the original driver.\r
-\r
-  @param NvRead\r
-  The read operation to access the NV data serviced by a hardware-specific driver.\r
-\r
-  @param NvWrite\r
-  The write operation to access the NV data serviced by a hardware-specific driver.\r
-\r
-  @param Callback\r
-  The function that is called from the configuration browser to communicate key value pairs.\r
-\r
 **/\r
 struct _EFI_FORM_CALLBACK_PROTOCOL {\r
-  EFI_NV_READ       NvRead;\r
-  EFI_NV_WRITE      NvWrite;\r
-  EFI_FORM_CALLBACK Callback;\r
+  EFI_NV_READ       NvRead;     ///< The read operation to access the NV data serviced by a hardware-specific driver.\r
+  EFI_NV_WRITE      NvWrite;    ///< The write operation to access the NV data serviced by a hardware-specific driver.\r
+  EFI_FORM_CALLBACK Callback;   ///< The function that is called from the configuration browser to communicate key value pairs.\r
 };\r
 \r
 extern EFI_GUID gEfiFormCallbackProtocolGuid;\r