Correct the structure's comments to follow doxygen format.

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

diff --git a/IntelFrameworkPkg/Include/Protocol/PciHotPlugInit.h b/IntelFrameworkPkg/Include/Protocol/PciHotPlugInit.h
index c8c46e832bbac2f9333ea93cc792854688ded856..341acb7308e1cb9b4688c8481662ab61dfed7062 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/PciHotPlugInit.h
+++ b/IntelFrameworkPkg/Include/Protocol/PciHotPlugInit.h
@@ -3,7 +3,7 @@
   This protocol provides the necessary functionality to initialize the Hot Plug Controllers (HPCs) and\r
   the buses that they control. This protocol also provides information regarding resource padding.\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
@@ -143,24 +143,24 @@ EFI_STATUS
 //\r
 \r
 /**\r
-  @par Protocol Description:\r
   This protocol provides the necessary functionality to initialize the\r
   Hot Plug Controllers (HPCs) and the buses that they control. This protocol\r
   also provides information regarding resource padding.\r
-\r
-  @param GetRootHpcList\r
-  Returns a list of root HPCs and the buses that they control.\r
-\r
-  @param InitializeRootHpc\r
-  Initializes the specified root HPC.\r
-\r
-  @param GetResourcePadding\r
-  Returns the resource padding that is required by the HPC.\r
-\r
 **/\r
 struct _EFI_PCI_HOT_PLUG_INIT_PROTOCOL {\r
+  ///\r
+  /// Returns a list of root HPCs and the buses that they control.\r
+  ///\r
   EFI_GET_ROOT_HPC_LIST                                  GetRootHpcList;\r
+  \r
+  ///\r
+  /// Initializes the specified root HPC.\r
+  ///\r
   EFI_INITIALIZE_ROOT_HPC                                InitializeRootHpc;\r
+  \r
+  ///\r
+  /// Returns the resource padding that is required by the HPC.\r
+  ///\r
   EFI_GET_PCI_HOT_PLUG_PADDING                           GetResourcePadding;\r
 };\r
 \r