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

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

diff --git a/MdePkg/Include/Protocol/SmmSxDispatch.h b/MdePkg/Include/Protocol/SmmSxDispatch.h
index dcbc6a9b982c030c337b8e0a997b5181f58ac428..4d6811f3fc19b15e8d7eabcfce5906e7d5067bf4 100644 (file)
--- a/MdePkg/Include/Protocol/SmmSxDispatch.h
+++ b/MdePkg/Include/Protocol/SmmSxDispatch.h
@@ -60,13 +60,13 @@ typedef struct {
 /**\r
   Dispatch function for a Sx state SMI handler.\r
 \r
-  @param  DispatchHandle Handle of this dispatch function.\r
-  @param  DispatchContext Pointer to the dispatch function¡¯s context. \r
-  The Type and Phase fields are filled in by the Sx dispatch driver \r
-  prior to invoking this dispatch function. For this interface, \r
-  the Sx driver will call the dispatch function for all Sx type \r
-  and phases, so the Sx state handler(s) must check the  Type and \r
-  Phase field of EFI_SMM_SX_DISPATCH_CONTEXT and act accordingly.\r
+  @param  DispatchHandle        Handle of this dispatch function.\r
+  @param  DispatchContext       Pointer to the dispatch function¡¯s context.\r
+                                The Type and Phase fields are filled in by the Sx dispatch driver\r
+                                prior to invoking this dispatch function. For this interface,\r
+                                the Sx driver will call the dispatch function for all Sx type\r
+                                and phases, so the Sx state handler(s) must check the Type and\r
+                                Phase field of EFI_SMM_SX_DISPATCH_CONTEXT and act accordingly.\r
 \r
   Nothing\r
 \r
@@ -81,30 +81,30 @@ VOID
 /**\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 which Sx state type and phase the caller\r
-  wishes to be called back on.  For this intertace,\r
-  the Sx driver will call the registered handlers for\r
-  all Sx type and phases, so the Sx state handler(s)\r
-  must check the Type and Phase field of the Dispatch\r
-  context and act accordingly.\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_UNSUPPORTED The Sx driver or hardware does not support that\r
-  Sx Type/Phase.\r
-  @retval  EFI_DEVICE_ERROR The Sx 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. Type & Phase are not\r
-  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 which Sx state type and phase the caller\r
+                                wishes to be called back on. For this intertace,\r
+                                the Sx driver will call the registered handlers for\r
+                                all Sx type and phases, so the Sx state handler(s)\r
+                                must check the Type and Phase field of the Dispatch\r
+                                context and act accordingly.\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_UNSUPPORTED       The Sx driver or hardware does not support that\r
+                                Sx Type/Phase.\r
+  @retval EFI_DEVICE_ERROR      The Sx 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. Type & Phase are not\r
+                                within valid range.\r
 \r
 **/\r
 typedef\r
@@ -119,14 +119,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 unregistered and the\r
-  SMI source has been disabled if there are no other registered child\r
-  dispatch functions for this SMI source.\r
-  @retval  EFI_INVALID_PARAMETER Handle is invalid.\r
-  @retval  other TBD\r
+  @retval EFI_SUCCESS           The dispatch function has been successfully unregistered and the\r
+                                SMI source has been disabled if there are no other registered child\r
+                                dispatch functions for this SMI source.\r
+  @retval EFI_INVALID_PARAMETER Handle is invalid.\r
+  @retval other                 TBD\r
 \r
 **/\r
 typedef\r