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

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

diff --git a/MdePkg/Include/Protocol/SmmSwDispatch.h b/MdePkg/Include/Protocol/SmmSwDispatch.h
index bc456cb5f2de22c99d1013189e4c660f8e70124a..2f4fecffb050a29d105ce848309cc01afbb9056b 100644 (file)
--- a/MdePkg/Include/Protocol/SmmSwDispatch.h
+++ b/MdePkg/Include/Protocol/SmmSwDispatch.h
@@ -49,13 +49,13 @@ typedef struct {
 /**\r
   Dispatch function for a Software SMI handler.\r
 \r
-  @param  DispatchHandle Handle of this dispatch function.\r
-  @param  DispatchContext Pointer to the dispatch function's context.\r
-  The SwSmiInputValue field is filled in\r
-  by the software dispatch driver prior to\r
-  invoking this dispatch function.\r
-  The dispatch function will only be called\r
-  for input values for which it is registered.\r
+  @param  DispatchHandle        Handle of this dispatch function.\r
+  @param  DispatchContext       Pointer to the dispatch function's context.\r
+                                The SwSmiInputValue field is filled in\r
+                                by the software dispatch driver prior to\r
+                                invoking this dispatch function.\r
+                                The dispatch function will only be called\r
+                                for input values for which it is registered.\r
 \r
   Nothing\r
 \r
@@ -70,24 +70,24 @@ 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 Software SMI input value the\r
-  dispatch function should be invoked for.\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 SW 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 SW SMI 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 which Software SMI input value the\r
+                                dispatch function should be invoked for.\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 SW 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 SW SMI input value\r
+                                is not within valid range.\r
 \r
 **/\r
 typedef\r
@@ -102,15 +102,15 @@ 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  other TBD\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 other                 TBD\r
 \r
 **/\r
 typedef\r