Correct the structure's comments to follow doxygen format.

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h
index bd5d0666b61101108f19b308d4ed75c4e91d04d2..8e3ed4fb29936960ec7f26a1935406066678524b 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h
@@ -1,7 +1,7 @@
 /** @file\r
   Provides the parent dispatch service for the periodical timer SMI source generator.\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
@@ -36,39 +36,25 @@ typedef struct _EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL  EFI_SMM_PERIODIC_TIMER
 //\r
 // Related Definitions\r
 //\r
-//\r
-// Period is the minimum period of time in 100 nanosecond units that child gets called.\r
-// The child will be called back after a time greater than the time Period.\r
-//\r
-// SmiTickInterval is the period of time interval between SMIs.  Children of this interface\r
-// should use this field when registering for periodic timer intervals when a finer\r
-// granularity periodic SMI is desired.  Valid values for this field are those returned\r
-// by GetNextInterval.  A value of 0 indicates the parent is allowed to use any SMI\r
-// interval period to satisfy the requested period.\r
-//    Example: A chipset supports periodic SMIs on every 64ms or 2 seconds.\r
-//      A child wishes schedule a period SMI to fire on a period of 3 seconds, there\r
-//      are several ways to approach the problem:\r
-//      1. The child may accept a 4 second periodic rate, in which case it registers with\r
-//           Period = 40000\r
-//           SmiTickInterval = 20000\r
-//         The resulting SMI will occur every 2 seconds with the child called back on\r
-//         every 2nd SMI.\r
-//         NOTE: the same result would occur if the child set SmiTickInterval = 0.\r
-//      2. The child may choose the finer granularity SMI (64ms):\r
-//           Period = 30000\r
-//           SmiTickInterval = 640\r
-//         The resulting SMI will occur every 64ms with the child called back on\r
-//         every 47th SMI.\r
-//         NOTE: the child driver should be aware that this will result in more\r
-//           SMIs occuring during system runtime which can negatively impact system\r
-//           performance.\r
-//\r
-// ElapsedTime is the actual time in 100 nanosecond units elapsed since last called, a\r
-// value of 0 indicates an unknown amount of time.\r
-//\r
+\r
 typedef struct {\r
+  ///\r
+  /// The minimum period of time in 100 nanosecond units that child gets called.\r
+  /// The child will be called back after a time greater than the time Period.\r
+  ///\r
   UINT64  Period;\r
+  ///\r
+  /// The period of time interval between SMIs.  Children of this interface\r
+  /// should use this field when registering for periodic timer intervals when a finer\r
+  /// granularity periodic SMI is desired.  Valid values for this field are those returned\r
+  /// by GetNextInterval.  A value of 0 indicates the parent is allowed to use any SMI\r
+  /// interval period to satisfy the requested period.\r
+  ///\r
   UINT64  SmiTickInterval;\r
+  ///\r
+  /// The actual time in 100 nanosecond units elapsed since last called, a\r
+  /// value of 0 indicates an unknown amount of time.\r
+  ///\r
   UINT64  ElapsedTime;\r
 } EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT;\r
 \r
@@ -170,22 +156,22 @@ EFI_STATUS
 // Interface structure for the SMM Periodic Timer Dispatch Protocol\r
 //\r
 /**\r
-  @par Protocol Description:\r
   Provides the parent dispatch service for the periodical timer SMI source generator.\r
-\r
-  @param Register\r
-  Installs a child service to be dispatched by this protocol.\r
-\r
-  @param UnRegister\r
-  Removes a child service dispatched by this protocol.\r
-\r
-  @param GetNextShorterInterval\r
-  Returns the next SMI tick period that is supported by the chipset.\r
-\r
 **/\r
 struct _EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL {\r
+  ///\r
+  /// Installs a child service to be dispatched by this protocol.\r
+  ///\r
   EFI_SMM_PERIODIC_TIMER_REGISTER   Register;\r
+  \r
+  ///\r
+  /// Removes a child service dispatched by this protocol.\r
+  ///\r
   EFI_SMM_PERIODIC_TIMER_UNREGISTER UnRegister;\r
+  \r
+  ///\r
+  /// Returns the next SMI tick period that is supported by the chipset.\r
+  ///\r
   EFI_SMM_PERIODIC_TIMER_INTERVAL   GetNextShorterInterval;\r
 };\r
 \r