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 283f6bed0001850e44a5deeef38d3019bc0035df..8e3ed4fb29936960ec7f26a1935406066678524b 100644 (file)
--- 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\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