summaryrefslogtreecommitdiff
path: root/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.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/SmmPeriodicTimerDispatch.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/SmmPeriodicTimerDispatch.h')
-rw-r--r--IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h22
1 files changed, 11 insertions, 11 deletions
diff --git a/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h
index 283f6bed00..8e3ed4fb29 100644
--- a/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h
@@ -156,22 +156,22 @@ EFI_STATUS
// Interface structure for the SMM Periodic Timer Dispatch Protocol
//
/**
- @par Protocol Description:
Provides the parent dispatch service for the periodical timer SMI source generator.
-
- @param Register
- Installs a child service to be dispatched by this protocol.
-
- @param UnRegister
- Removes a child service dispatched by this protocol.
-
- @param GetNextShorterInterval
- Returns the next SMI tick period that is supported by the chipset.
-
**/
struct _EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL {
+ ///
+ /// Installs a child service to be dispatched by this protocol.
+ ///
EFI_SMM_PERIODIC_TIMER_REGISTER Register;
+
+ ///
+ /// Removes a child service dispatched by this protocol.
+ ///
EFI_SMM_PERIODIC_TIMER_UNREGISTER UnRegister;
+
+ ///
+ /// Returns the next SMI tick period that is supported by the chipset.
+ ///
EFI_SMM_PERIODIC_TIMER_INTERVAL GetNextShorterInterval;
};