Update structure's comments to doxygen style.

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

diff --git a/IntelFrameworkPkg/Include/Protocol/DataHub.h b/IntelFrameworkPkg/Include/Protocol/DataHub.h
index 69e5058416b42f47baee67c4a4ce1b99871f7317..82bd928751aaba5bb68b3c829f2aefad8d4ed6dd 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/DataHub.h
+++ b/IntelFrameworkPkg/Include/Protocol/DataHub.h
@@ -6,7 +6,7 @@
   For more information please look at Intel Platform Innovation\r
   Framework for EFI Data Hub Specification.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 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
@@ -184,28 +184,29 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  @par Protocol Description:\r
   This protocol is used to log information and register filter drivers\r
   to receive data records.\r
-\r
-  @param LogData\r
-  Logs a data record.\r
-\r
-  @param GetNextDataRecord\r
-  Gets a data record. Used both to view the memory-based log and to\r
-  get information about which data records have been consumed by a filter driver.\r
-\r
-  @param RegisterFilterDriver\r
-  Allows the registration of an EFI event to act as a filter driver for all data records that are logged.\r
-\r
-  @param UnregisterFilterDriver\r
-  Used to remove a filter driver that was added with RegisterFilterDriver().\r
-\r
 **/\r
 struct _EFI_DATA_HUB_PROTOCOL {\r
-  EFI_DATA_HUB_LOG_DATA                 LogData;\r
+  ///\r
+  /// Logs a data record.\r
+  ///\r
+  EFI_DATA_HUB_LOG_DATA                 LogData; \r
+  \r
+  ///\r
+  /// Gets a data record. Used both to view the memory-based log and to\r
+  /// get information about which data records have been consumed by a filter driver.\r
+  ///\r
   EFI_DATA_HUB_GET_NEXT_RECORD          GetNextRecord;\r
+  \r
+  ///\r
+  /// Allows the registration of an EFI event to act as a filter driver for all data records that are logged.\r
+  ///\r
   EFI_DATA_HUB_REGISTER_FILTER_DRIVER   RegisterFilterDriver;\r
+  \r
+  ///\r
+  /// Used to remove a filter driver that was added with RegisterFilterDriver().\r
+  ///\r
   EFI_DATA_HUB_UNREGISTER_FILTER_DRIVER UnregisterFilterDriver;\r
 };\r
 \r