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

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

diff --git a/MdePkg/Include/Protocol/PciHotPlugInit.h b/MdePkg/Include/Protocol/PciHotPlugInit.h
index b4b5a3d4b953adec5dd87d5687cedab73ff5361c..efd4c454a61aba95e94b15dc621a4eab02fecc27 100644 (file)
--- a/MdePkg/Include/Protocol/PciHotPlugInit.h
+++ b/MdePkg/Include/Protocol/PciHotPlugInit.h
@@ -51,17 +51,13 @@ typedef enum{
   Returns a list of root Hot Plug Controllers (HPCs) that require initialization \r
   during the boot process.\r
 \r
-  @param  This Pointer to the EFI_PCI_HOT_PLUG_INIT_PROTOCOL instance.\r
-  \r
-  @param  HpcCount The number of root HPCs that were returned.\r
-  \r
-  @param  HpcList The list of root HPCs. HpcCount defines the number of \r
-  elements in this list.\r
+  @param  This                  Pointer to the EFI_PCI_HOT_PLUG_INIT_PROTOCOL instance.\r
+  @param  HpcCount              The number of root HPCs that were returned.\r
+  @param  HpcList               The list of root HPCs. HpcCount defines the number of\r
+                                elements in this list.\r
 \r
-  @retval EFI_SUCCESS HpcList was returned.\r
-  \r
-  @retval EFI_OUT_OF_RESOURCES HpcList was not returned due to insufficient resources.\r
-  \r
+  @retval EFI_SUCCESS           HpcList was returned.\r
+  @retval EFI_OUT_OF_RESOURCES  HpcList was not returned due to insufficient resources.\r
   @retval EFI_INVALID_PARAMETER HpcCount is NULL or HpcList is NULL.\r
 \r
 **/\r
@@ -77,27 +73,20 @@ EFI_STATUS
   Initializes one root Hot Plug Controller (HPC). This process may causes \r
   initialization of its subordinate buses. \r
 \r
-  @param  This Pointer to the EFI_PCI_HOT_PLUG_INIT_PROTOCOL instance.\r
-  \r
-  @param  HpcDevicePath The device path to the HPC that is being initialized.\r
-  \r
-  @param  HpcPciAddress The address of the HPC function on the PCI bus.\r
-  \r
-  @param  Event The event that should be signaled when the HPC initialization \r
-  is complete.\r
-  \r
-  @param  HpcState The state of the HPC hardware. \r
-\r
-  @retval EFI_SUCCESS If Event is NULL, the specific HPC was successfully \r
-  initialized. If Event is not NULL,  Event will be signaled at a later time \r
-  when initialization is complete.\r
-  \r
-  @retval EFI_UNSUPPORTED This instance of EFI_PCI_HOT_PLUG_INIT_PROTOCOL \r
-  does not support the specified HPC.\r
-  \r
-  @retval EFI_OUT_OF_RESOURCES Initialization failed due to insufficient \r
-  resources.\r
-  \r
+  @param  This                  Pointer to the EFI_PCI_HOT_PLUG_INIT_PROTOCOL instance.\r
+  @param  HpcDevicePath         The device path to the HPC that is being initialized.\r
+  @param  HpcPciAddress         The address of the HPC function on the PCI bus.\r
+  @param  Event                 The event that should be signaled when the HPC initialization\r
+                                is complete.\r
+  @param  HpcState              The state of the HPC hardware.\r
+\r
+  @retval EFI_SUCCESS           If Event is NULL, the specific HPC was successfully\r
+                                initialized. If Event is not NULL, Event will be signaled at a later time\r
+                                when initialization is complete.\r
+  @retval EFI_UNSUPPORTED       This instance of EFI_PCI_HOT_PLUG_INIT_PROTOCOL\r
+                                does not support the specified HPC.\r
+  @retval EFI_OUT_OF_RESOURCES  Initialization failed due to insufficient\r
+                                resources.\r
   @retval EFI_INVALID_PARAMETER HpcState is NULL.\r
 \r
 **/\r
@@ -115,31 +104,22 @@ EFI_STATUS
   Returns the resource padding that is required by the PCI bus that is controlled \r
   by the specified Hot Plug Controller (HPC).\r
 \r
-  @param  This Pointer to the EFI_PCI_HOT_PLUG_INIT_PROTOCOL instance.\r
-  \r
-  @param  HpcDevicePath The device path to the HPC.\r
-  \r
-  @param  HpcPciAddress The address of the HPC function on the PCI bus. \r
-  \r
-  @param  HpcState The state of the HPC hardware. \r
-  \r
-  @param  Padding The amount of resource padding that is required by the \r
-  PCI bus under the control of the specified HPC. \r
-  \r
-  @param  Attributes Describes how padding is accounted for. The padding \r
-  is returned in the form of ACPI 2.0 resource descriptors. \r
-\r
-  @retval EFI_SUCCESS The resource padding was successfully returned.\r
-  \r
-  @retval EFI_UNSUPPORTED This instance of the EFI_PCI_HOT_PLUG_INIT_PROTOCOL \r
-  does not support the specified HPC.\r
-  \r
-  @retval EFI_NOT_READY This function was called before HPC initialization is complete.\r
-  \r
-  @retval EFI_INVALID_PARAMETER  HpcState or Padding or Attributes is NULL.\r
-  \r
-  @retval EFI_OUT_OF_RESOURCES ACPI 2.0 resource descriptors for Padding \r
-  cannot be allocated due to insufficient resources.\r
+  @param  This                  Pointer to the EFI_PCI_HOT_PLUG_INIT_PROTOCOL instance.\r
+  @param  HpcDevicePath         The device path to the HPC.\r
+  @param  HpcPciAddress         The address of the HPC function on the PCI bus.\r
+  @param  HpcState              The state of the HPC hardware.\r
+  @param  Padding               The amount of resource padding that is required by the\r
+                                PCI bus under the control of the specified HPC.\r
+  @param  Attributes            Describes how padding is accounted for. The padding\r
+                                is returned in the form of ACPI 2.0 resource descriptors.\r
+\r
+  @retval EFI_SUCCESS           The resource padding was successfully returned.\r
+  @retval EFI_UNSUPPORTED       This instance of the EFI_PCI_HOT_PLUG_INIT_PROTOCOL\r
+                                does not support the specified HPC.\r
+  @retval EFI_NOT_READY         This function was called before HPC initialization is complete.\r
+  @retval EFI_INVALID_PARAMETER HpcState or Padding or Attributes is NULL.\r
+  @retval EFI_OUT_OF_RESOURCES  ACPI 2.0 resource descriptors for Padding\r
+                                cannot be allocated due to insufficient resources.\r
 \r
 **/\r
 typedef\r