]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/AcpiTable.h
Code Scrub for Protocol and Ppi Definition
[mirror_edk2.git] / MdePkg / Include / Protocol / AcpiTable.h
index 99159f47bacd90e15129588c313b4737eee12776..9ccf2ecea0a207656b6d2dd1c48c6dfa6f48c0a3 100644 (file)
@@ -2,7 +2,7 @@
   The file provides the protocol to install or remove an ACPI\r
   table from a platform. \r
   \r
-  Copyright (c) 2006 - 2007, Intel Corporation\r
+  Copyright (c) 2006 - 2008, Intel Corporation\r
   All rights reserved. This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r
   which accompanies this distribution.  The full text of the license may be found at        \r
@@ -39,18 +39,18 @@ typedef struct _EFI_ACPI_TABLE_PROTOCOL EFI_ACPI_TABLE_PROTOCOL;
   longer considered valid.   \r
 \r
 \r
-  @param This A pointer to a EFI_ACPI_TABLE_PROTOCOL.\r
+  @param This                 A pointer to a EFI_ACPI_TABLE_PROTOCOL.\r
 \r
-  @param AcpiTableBuffer  A pointer to a buffer containing the\r
-                          ACPI table to be installed.\r
+  @param AcpiTableBuffer      A pointer to a buffer containing the\r
+                              ACPI table to be installed.\r
 \r
   @param AcpiTableBufferSize  Specifies the size, in bytes, of\r
                               the AcpiTableBuffer buffer.\r
 \r
 \r
-  @param TableKey   Returns a key to refer to the ACPI table.\r
+  @param TableKey             Returns a key to refer to the ACPI table.\r
   \r
-  @retval EFI_SUCCESS The table was successfully inserted\r
+  @retval EFI_SUCCESS           The table was successfully inserted\r
   \r
   @retval EFI_INVALID_PARAMETER Either AcpiTableBuffer is NULL,\r
                                 TableKey is NULL, or\r
@@ -83,15 +83,15 @@ EFI_STATUS
   EFI_CONFIGURATION_TABLE pointer to the RSDT is no longer\r
   considered valid.\r
 \r
-  @param This A pointer to a EFI_ACPI_TABLE_PROTOCOL.\r
+  @param This                   A pointer to a EFI_ACPI_TABLE_PROTOCOL.\r
 \r
-  @param TableKey Specifies the table to uninstall. The key was\r
-                  returned from InstallAcpiTable().\r
+  @param TableKey               Specifies the table to uninstall. The key was\r
+                                returned from InstallAcpiTable().\r
 \r
-  @retval EFI_SUCCESS The table was successfully inserted\r
+  @retval EFI_SUCCESS           The table was successfully inserted\r
 \r
-  @retval EFI_NOT_FOUND TableKey does not refer to a valid key\r
-                        for a table entry.\r
+  @retval EFI_NOT_FOUND         TableKey does not refer to a valid key\r
+                                for a table entry.\r
 \r
   @retval EFI_OUT_OF_RESOURCES  Insufficient resources exist to\r
                                 complete the request.\r
@@ -105,12 +105,12 @@ EFI_STATUS
 );\r
 \r
 /**\r
+  @par Protocol Description:\r
   The EFI_ACPI_TABLE_PROTOCOL provides the ability for a component\r
   to install and uninstall ACPI tables from a platform.\r
 \r
 \r
-  @param InstallAcpiTable Installs an ACPI table into the\r
-                          system.\r
+  @param InstallAcpiTable   Installs an ACPI table into the system.\r
 \r
   @param UninstallAcpiTable Removes a previously installed ACPI\r
                             table from the system.\r