summaryrefslogtreecommitdiff
path: root/IntelFrameworkPkg/Include/Protocol/PciHotPlugInit.h
diff options
context:
space:
mode:
authorklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>2009-07-02 07:40:24 +0000
committerklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>2009-07-02 07:40:24 +0000
commit2bbaeb0d624f1d7758edd0a8d61322af209a1b1a (patch)
tree4e6161f7b624d87883fe7be6b53f4ff20203bb36 /IntelFrameworkPkg/Include/Protocol/PciHotPlugInit.h
parentd97286f4b36691776d0affe525387a9b56b6ba4f (diff)
downloadedk2-platforms-2bbaeb0d624f1d7758edd0a8d61322af209a1b1a.tar.xz
Correct the structure's comments to follow doxygen format.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8721 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'IntelFrameworkPkg/Include/Protocol/PciHotPlugInit.h')
-rw-r--r--IntelFrameworkPkg/Include/Protocol/PciHotPlugInit.h24
1 files changed, 12 insertions, 12 deletions
diff --git a/IntelFrameworkPkg/Include/Protocol/PciHotPlugInit.h b/IntelFrameworkPkg/Include/Protocol/PciHotPlugInit.h
index c8c46e832b..341acb7308 100644
--- 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
the buses that they control. This protocol also provides information regarding resource padding.
- Copyright (c) 2007, Intel Corporation
+ Copyright (c) 2007 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -143,24 +143,24 @@ EFI_STATUS
//
/**
- @par Protocol Description:
This protocol provides the necessary functionality to initialize the
Hot Plug Controllers (HPCs) and the buses that they control. This protocol
also provides information regarding resource padding.
-
- @param GetRootHpcList
- Returns a list of root HPCs and the buses that they control.
-
- @param InitializeRootHpc
- Initializes the specified root HPC.
-
- @param GetResourcePadding
- Returns the resource padding that is required by the HPC.
-
**/
struct _EFI_PCI_HOT_PLUG_INIT_PROTOCOL {
+ ///
+ /// Returns a list of root HPCs and the buses that they control.
+ ///
EFI_GET_ROOT_HPC_LIST GetRootHpcList;
+
+ ///
+ /// Initializes the specified root HPC.
+ ///
EFI_INITIALIZE_ROOT_HPC InitializeRootHpc;
+
+ ///
+ /// Returns the resource padding that is required by the HPC.
+ ///
EFI_GET_PCI_HOT_PLUG_PADDING GetResourcePadding;
};