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

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

diff --git a/MdePkg/Include/Protocol/SmmControl.h b/MdePkg/Include/Protocol/SmmControl.h
index 3bcd0f772eed344901937b5ad3b6e7c773abdf6f..a83d25bf85dae0eec8aaef26f725d5743eab8705 100644 (file)
--- a/MdePkg/Include/Protocol/SmmControl.h
+++ b/MdePkg/Include/Protocol/SmmControl.h
@@ -41,24 +41,17 @@ typedef struct {
 /**\r
   Invokes SMI activation from either the preboot or runtime environment.\r
 \r
-  @param  This The EFI_SMM_CONTROL_PROTOCOL instance. \r
-  \r
-  @param  ArgumentBuffer Optional sized data to pass into the protocol activation. \r
-  \r
-  @param  ArgumentBufferSize Optional size of the data.\r
-  \r
-  @param  Periodic Optional mechanism to engender a periodic stream.\r
-  \r
-  @param  ActivationInterval Optional parameter to repeat at this period one \r
-  time or, if the Periodic Boolean is set, periodically.\r
-\r
-  @retval EFI_SUCCESS  The SMI/PMI has been engendered.\r
-  \r
-  @retval EFI_DEVICE_ERROR  The timing is unsupported.\r
-  \r
-  @retval EFI_INVALID_PARAMETER  The activation period is unsupported.\r
-  \r
-  @retval EFI_NOT_STARTED  The SMM base service has not been initialized.\r
+  @param  This                  The EFI_SMM_CONTROL_PROTOCOL instance.\r
+  @param  ArgumentBuffer        Optional sized data to pass into the protocol activation.\r
+  @param  ArgumentBufferSize    Optional size of the data.\r
+  @param  Periodic              Optional mechanism to engender a periodic stream.\r
+  @param  ActivationInterval    Optional parameter to repeat at this period one\r
+                                time or, if the Periodic Boolean is set, periodically.\r
+\r
+  @retval EFI_SUCCESS           The SMI/PMI has been engendered.\r
+  @retval EFI_DEVICE_ERROR      The timing is unsupported.\r
+  @retval EFI_INVALID_PARAMETER The activation period is unsupported.\r
+  @retval EFI_NOT_STARTED       The SMM base service has not been initialized.\r
 \r
 **/\r
 typedef\r
@@ -74,15 +67,12 @@ EFI_STATUS
 /**\r
   Clears any system state that was created in response to the Active call.\r
 \r
-  @param  This The EFI_SMM_CONTROL_PROTOCOL instance. \r
-  \r
-  @param  Periodic Optional parameter to repeat at this period one time\r
+  @param  This                  The EFI_SMM_CONTROL_PROTOCOL instance.\r
+  @param  Periodic              Optional parameter to repeat at this period one time\r
 \r
-  @retval EFI_SUCCESS  The SMI/PMI has been engendered.\r
-  \r
-  @retval EFI_DEVICE_ERROR  The source could not be cleared.\r
-  \r
-  @retval EFI_INVALID_PARAMETER  The service did not support the Periodic input argument.\r
+  @retval EFI_SUCCESS           The SMI/PMI has been engendered.\r
+  @retval EFI_DEVICE_ERROR      The source could not be cleared.\r
+  @retval EFI_INVALID_PARAMETER The service did not support the Periodic input argument.\r
 \r
 **/\r
 typedef\r
@@ -95,11 +85,10 @@ EFI_STATUS
 /**\r
   Provides information on the source register used to generate the SMI.\r
 \r
-  @param  This The EFI_SMM_CONTROL_PROTOCOL instance. \r
-  \r
-  @param  SmiRegister Pointer to the SMI register description structure\r
+  @param  This                  The EFI_SMM_CONTROL_PROTOCOL instance.\r
+  @param  SmiRegister           Pointer to the SMI register description structure\r
 \r
-  @retval EFI_SUCCESS  The register structure has been returned.\r
+  @retval EFI_SUCCESS           The register structure has been returned.\r
 \r
 **/\r
 typedef\r