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

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

diff --git a/MdePkg/Include/Protocol/AcpiSupport.h b/MdePkg/Include/Protocol/AcpiSupport.h
index 790cdf2b3ecbf8605a18e874249f28b38f6a790e..5702cb4d6547e7ee3ff9b42763222386d705033a 100644 (file)
--- a/MdePkg/Include/Protocol/AcpiSupport.h
+++ b/MdePkg/Include/Protocol/AcpiSupport.h
@@ -64,19 +64,14 @@ typedef struct _EFI_ACPI_SUPPORT_PROTOCOL EFI_ACPI_SUPPORT_PROTOCOL;
 /**\r
   Returns a requested ACPI table.\r
 \r
 /**\r
   Returns a requested ACPI table.\r
 \r

-  @param  This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r
-  \r
-  @param  Index The zero-based index of the table to retrieve.\r
-  \r
-  @param  Table Pointer for returning the table buffer.\r
-  \r
-  @param  Version Updated with the ACPI versions to which this table belongs.\r
-  \r
-  @param  Handle Pointer for identifying the table.\r
+  @param  This                  A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r
+  @param  Index                 The zero-based index of the table to retrieve.\r
+  @param  Table                 Pointer for returning the table buffer.\r
+  @param  Version               Updated with the ACPI versions to which this table belongs.\r
+  @param  Handle                Pointer for identifying the table.\r

 \r
 \r

-  @retval EFI_SUCCESS The function completed successfully.\r
-  \r
-  @retval EFI_NOT_FOUND The requested index is too large and a table was not found.\r
+  @retval EFI_SUCCESS           The function completed successfully.\r
+  @retval EFI_NOT_FOUND         The requested index is too large and a table was not found.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -92,22 +87,16 @@ EFI_STATUS
 /**\r
   Used to add, remove, or update ACPI tables.\r
 \r
 /**\r
   Used to add, remove, or update ACPI tables.\r
 \r

-  @param  This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r
-  \r
-  @param  Table Pointer to the new table to add or update.\r
-  \r
-  @param  Checksum If TRUE, indicates that the checksum should be \r
-  calculated for this table.\r
-  \r
-  @param  Version Indicates to which version(s) of ACPI the table should be added.\r
-  \r
-  @param  Pointer to the handle of the table to remove or update.\r
+  @param  This                  A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r
+  @param  Table                 Pointer to the new table to add or update.\r
+  @param  Checksum              If TRUE, indicates that the checksum should be\r
+                                calculated for this table.\r
+  @param  Version               Indicates to which version(s) of ACPI the table should be added.\r
+  @param  Pointer               to the handle of the table to remove or update.\r

 \r
 \r

-  @retval EFI_SUCCESS The function completed successfully.\r
-  \r
+  @retval EFI_SUCCESS           The function completed successfully.\r

   @retval EFI_INVALID_PARAMETER *Handle was zero and Table was NULL.\r
   @retval EFI_INVALID_PARAMETER *Handle was zero and Table was NULL.\r

-  \r
-  @retval EFI_ABORTED Could not complete the desired action.\r
+  @retval EFI_ABORTED           Could not complete the desired action.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -124,13 +113,11 @@ EFI_STATUS
   Causes one or more versions of the ACPI tables to be published in \r
   the EFI system configuration tables.\r
 \r
   Causes one or more versions of the ACPI tables to be published in \r
   the EFI system configuration tables.\r
 \r

-  @param  This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r
-  \r
-  @param  Version Indicates to which version(s) of ACPI that the table should be published. \r
+  @param  This                  A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.\r
+  @param  Version               Indicates to which version(s) of ACPI that the table should be published.\r

 \r
 \r

-  @retval EFI_SUCCESS The function completed successfully.\r
-  \r
-  @retval EFI_ABORTED An error occurred and the function could not complete successfully.\r
+  @retval EFI_SUCCESS           The function completed successfully.\r
+  @retval EFI_ABORTED           An error occurred and the function could not complete successfully.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r