Remove BugBug in comments and adjust function header according to code style doc.

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

diff --git a/MdePkg/Include/Protocol/SmmPeriodicTimerDispatch.h b/MdePkg/Include/Protocol/SmmPeriodicTimerDispatch.h
index c94843fcca7ec161461b60f89b3e37845c69c599..75f3e80b9cb2496f113dd749904403f48844a062 100644 (file)
--- a/MdePkg/Include/Protocol/SmmPeriodicTimerDispatch.h
+++ b/MdePkg/Include/Protocol/SmmPeriodicTimerDispatch.h
@@ -76,11 +76,11 @@ typedef struct {
 /**\r
   Dispatch function for a Periodic Timer SMI handler.\r
 \r
-  @param  DispatchHandle Handle of this dispatch function.\r
-  @param  DispatchContext Pointer to the dispatch function's context.\r
-  The DispatchContext fields are filled in\r
-  by the dispatching driver prior to\r
-  invoking this dispatch function.\r
+  @param  DispatchHandle        Handle of this dispatch function.\r
+  @param  DispatchContext       Pointer to the dispatch function's context.\r
+                                The DispatchContext fields are filled in\r
+                                by the dispatching driver prior to\r
+                                invoking this dispatch function.\r
 \r
   Nothing\r
 \r
@@ -96,15 +96,15 @@ VOID
   Returns the next SMI tick period supported by the chipset.  The order\r
   returned is from longest to shortest interval period.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  SmiTickInterval Pointer to pointer of next shorter SMI interval\r
-  period supported by the child.  This parameter works as a get-first, \r
-  get-next field.The first time this function is called, *SmiTickInterval \r
-  should be set to NULL to get the longest SMI interval.The returned \r
-  *SmiTickInterval should be passed in on subsequent calls to get the \r
-  next shorter interval period until *SmiTickInterval = NULL.\r
+  @param  This                  Protocol instance pointer.\r
+  @param  SmiTickInterval       Pointer to pointer of next shorter SMI interval\r
+                                period supported by the child. This parameter works as a get-first,\r
+                                get-next field.The first time this function is called, *SmiTickInterval\r
+                                should be set to NULL to get the longest SMI interval.The returned\r
+                                *SmiTickInterval should be passed in on subsequent calls to get the\r
+                                next shorter interval period until *SmiTickInterval = NULL.\r
 \r
-  @retval EFI_SUCCESS The service returned successfully.\r
+  @retval EFI_SUCCESS           The service returned successfully.\r
 \r
 **/\r
 typedef\r
@@ -117,24 +117,24 @@ EFI_STATUS
 /**\r
   Register a child SMI source dispatch function with a parent SMM driver\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  DispatchFunction Pointer to dispatch function to be invoked for\r
-  this SMI source\r
-  @param  DispatchContext Pointer to the dispatch function's context.\r
-  The caller fills this context in before calling\r
-  the register function to indicate to the register\r
-  function the period at which the dispatch function\r
-  should be invoked.\r
-  @param  DispatchHandle Handle of dispatch function, for when interfacing\r
-  with the parent Sx state SMM driver.\r
-\r
-  @retval  EFI_SUCCESS The dispatch function has been successfully\r
-  registered and the SMI source has been enabled.\r
-  @retval  EFI_DEVICE_ERROR The driver was unable to enable the SMI source.\r
-  @retval  EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this\r
-  child.\r
-  @retval  EFI_INVALID_PARAMETER DispatchContext is invalid. The period input value\r
-  is not within valid range.\r
+  @param  This                  Protocol instance pointer.\r
+  @param  DispatchFunction      Pointer to dispatch function to be invoked for\r
+                                this SMI source\r
+  @param  DispatchContext       Pointer to the dispatch function's context.\r
+                                The caller fills this context in before calling\r
+                                the register function to indicate to the register\r
+                                function the period at which the dispatch function\r
+                                should be invoked.\r
+  @param  DispatchHandle        Handle of dispatch function, for when interfacing\r
+                                with the parent Sx state SMM driver.\r
+\r
+  @retval EFI_SUCCESS           The dispatch function has been successfully\r
+                                registered and the SMI source has been enabled.\r
+  @retval EFI_DEVICE_ERROR      The driver was unable to enable the SMI source.\r
+  @retval EFI_OUT_OF_RESOURCES  Not enough memory (system or SMM) to manage this\r
+                                child.\r
+  @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The period input value\r
+                                is not within valid range.\r
 \r
 **/\r
 typedef\r
@@ -149,14 +149,14 @@ EFI_STATUS
 /**\r
   Unregister a child SMI source dispatch function with a parent SMM driver\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  DispatchHandle Handle of dispatch function to deregister.\r
+  @param  This                  Protocol instance pointer.\r
+  @param  DispatchHandle        Handle of dispatch function to deregister.\r
 \r
-  @retval  EFI_SUCCESS The dispatch function has been successfully\r
-  unregistered and the SMI source has been disabled\r
-  if there are no other registered child dispatch\r
-  functions for this SMI source.\r
-  @retval  EFI_INVALID_PARAMETER Handle is invalid.\r
+  @retval EFI_SUCCESS           The dispatch function has been successfully\r
+                                unregistered and the SMI source has been disabled\r
+                                if there are no other registered child dispatch\r
+                                functions for this SMI source.\r
+  @retval EFI_INVALID_PARAMETER Handle is invalid.\r
 \r
 **/\r
 typedef\r