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

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@1055 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 65 insertions, 65 deletions

diff --git a/MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h b/MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h
index 9d83c5aedb..147d07c8f7 100644
--- a/MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h
+++ b/MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h
@@ -128,13 +128,13 @@ typedef enum {
 /**

   Enter a certain phase of the PCI enumeration process

 

-  @param  This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance

-  @param  Phase The phase during enumeration

+  @param  This                  The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance

+  @param  Phase                 The phase during enumeration

 

-  @retval  EFI_SUCCESS Success

-  @retval  EFI_OUT_OF_RESOURCES If SubmitResources ( ) could not allocate resources

-  @retval  EFI_NOT_READY This phase cannot be entered at this time

-  @retval  EFI_DEVICE_ERROR SetResources failed due to HW error.

+  @retval EFI_SUCCESS           Success

+  @retval EFI_OUT_OF_RESOURCES  If SubmitResources ( ) could not allocate resources

+  @retval EFI_NOT_READY         This phase cannot be entered at this time

+  @retval EFI_DEVICE_ERROR      SetResources failed due to HW error.

 

 **/

 typedef

@@ -149,14 +149,14 @@ EFI_STATUS
   Return the device handle of the next PCI root bridge that is associated with 

   this Host Bridge

 

-  @param  This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance

-  @param  RootBridgeHandle Returns the device handle of the next PCI Root Bridge.

-  On input, it holds the RootBridgeHandle returned by the most

-  recent call to GetNextRootBridge().The handle for the first

-  PCI Root Bridge is returned if RootBridgeHandle is NULL on input

+  @param  This                  The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance

+  @param  RootBridgeHandle      Returns the device handle of the next PCI Root Bridge.

+                                On input, it holds the RootBridgeHandle returned by the most

+                                recent call to GetNextRootBridge().The handle for the first

+                                PCI Root Bridge is returned if RootBridgeHandle is NULL on input

 

-  @retval  EFI_SUCCESS Success

-  @retval  EFI_INVALID_PARAMETER RootBridgeHandle is invalid

+  @retval EFI_SUCCESS           Success

+  @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid

 

 **/

 typedef

@@ -170,14 +170,14 @@ EFI_STATUS
 /**

   Returns the attributes of a PCI Root Bridge.

 

-  @param  This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance

-  @param  RootBridgeHandle The device handle of the PCI Root Bridge

-  that the caller is interested in

-  @param  Attribute The pointer to attributes of the PCI Root Bridge

+  @param  This                  The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance

+  @param  RootBridgeHandle      The device handle of the PCI Root Bridge

+                                that the caller is interested in

+  @param  Attribute             The pointer to attributes of the PCI Root Bridge

 

-  @retval  EFI_SUCCESS Success

-  @retval  EFI_INVALID_PARAMETER RootBridgeHandle is invalid

-  @retval  EFI_INVALID_PARAMETER Attributes is NULL

+  @retval EFI_SUCCESS           Success

+  @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid

+  @retval EFI_INVALID_PARAMETER Attributes is NULL

 

 **/

 typedef

@@ -193,14 +193,14 @@ EFI_STATUS
   This is the request from the PCI enumerator to set up 

   the specified PCI Root Bridge for bus enumeration process. 

 

-  @param  This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance

-  @param  RootBridgeHandle The PCI Root Bridge to be set up

-  @param  Configuration Pointer to the pointer to the PCI bus resource descriptor

+  @param  This                  The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance

+  @param  RootBridgeHandle      The PCI Root Bridge to be set up

+  @param  Configuration         Pointer to the pointer to the PCI bus resource descriptor

 

-  @retval  EFI_SUCCESS Success

-  @retval  EFI_INVALID_PARAMETER RootBridgeHandle is invalid

-  @retval  EFI_DEVICE_ERROR Request failed due to hardware error

-  @retval  EFI_OUT_OF_RESOURCES Request failed due to lack of resources

+  @retval EFI_SUCCESS           Success

+  @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid

+  @retval EFI_DEVICE_ERROR      Request failed due to hardware error

+  @retval EFI_OUT_OF_RESOURCES  Request failed due to lack of resources

 

 **/

 typedef

@@ -216,20 +216,20 @@ EFI_STATUS
   This function programs the PCI Root Bridge hardware so that 

   it decodes the specified PCI bus range

 

-  @param  This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance

-  @param  RootBridgeHandle The PCI Root Bridge whose bus range is to be programmed

-  @param  Configuration The pointer to the PCI bus resource descriptor

-

-  @retval  EFI_SUCCESS Success

-  @retval  EFI_INVALID_PARAMETER RootBridgeHandle is invalid

-  @retval  EFI_INVALID_PARAMETER Configuration is NULL

-  @retval  EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI resource descriptor

-  @retval  EFI_INVALID_PARAMETER Configuration contains one or more memory or IO ACPI resource descriptor

-  @retval  EFI_INVALID_PARAMETER Address Range Minimum or Address Range Length fields in Configuration

-  are invalid for this Root Bridge.

-  @retval  EFI_INVALID_PARAMETER Configuration contains one or more invalid ACPI resource descriptor

-  @retval  EFI_DEVICE_ERROR Request failed due to hardware error

-  @retval  EFI_OUT_OF_RESOURCES Request failed due to lack of resources

+  @param  This                  The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance

+  @param  RootBridgeHandle      The PCI Root Bridge whose bus range is to be programmed

+  @param  Configuration         The pointer to the PCI bus resource descriptor

+

+  @retval EFI_SUCCESS           Success

+  @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid

+  @retval EFI_INVALID_PARAMETER Configuration is NULL

+  @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI resource descriptor

+  @retval EFI_INVALID_PARAMETER Configuration contains one or more memory or IO ACPI resource descriptor

+  @retval EFI_INVALID_PARAMETER Address Range Minimum or Address Range Length fields in Configuration

+                                are invalid for this Root Bridge.

+  @retval EFI_INVALID_PARAMETER Configuration contains one or more invalid ACPI resource descriptor

+  @retval EFI_DEVICE_ERROR      Request failed due to hardware error

+  @retval EFI_OUT_OF_RESOURCES  Request failed due to lack of resources

 

 **/

 typedef

@@ -244,16 +244,16 @@ EFI_STATUS
 /**

   Submits the I/O and memory resource requirements for the specified PCI Root Bridge

 

-  @param  This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance

-  @param  RootBridgeHandle The PCI Root Bridge whose I/O and memory resource requirements

-  are being submitted

-  @param  Configuration The pointer to the PCI I/O and PCI memory resource descriptor

+  @param  This                  The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance

+  @param  RootBridgeHandle      The PCI Root Bridge whose I/O and memory resource requirements

+                                are being submitted

+  @param  Configuration         The pointer to the PCI I/O and PCI memory resource descriptor

 

-  @retval  EFI_SUCCESS Success

-  @retval  EFI_INVALID_PARAMETER RootBridgeHandle is invalid

-  @retval  EFI_INVALID_PARAMETER Configuration is NULL

-  @retval  EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI resource descriptor

-  @retval  EFI_INVALID_PARAMETER Configuration includes a resource descriptor of unsupported type

+  @retval EFI_SUCCESS           Success

+  @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid

+  @retval EFI_INVALID_PARAMETER Configuration is NULL

+  @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI resource descriptor

+  @retval EFI_INVALID_PARAMETER Configuration includes a resource descriptor of unsupported type

 

 **/

 typedef

@@ -269,15 +269,15 @@ EFI_STATUS
   This function returns the proposed resource settings for the specified 

   PCI Root Bridge

 

-  @param  This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance

-  @param  RootBridgeHandle The PCI Root Bridge handle

-  @param  Configuration The pointer to the pointer to the PCI I/O

-  and memory resource descriptor

+  @param  This                  The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance

+  @param  RootBridgeHandle      The PCI Root Bridge handle

+  @param  Configuration         The pointer to the pointer to the PCI I/O

+                                and memory resource descriptor

 

-  @retval  EFI_SUCCESS Success

-  @retval  EFI_INVALID_PARAMETER RootBridgeHandle is invalid

-  @retval  EFI_DEVICE_ERROR Request failed due to hardware error

-  @retval  EFI_OUT_OF_RESOURCES Request failed due to lack of resources

+  @retval EFI_SUCCESS           Success

+  @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid

+  @retval EFI_DEVICE_ERROR      Request failed due to hardware error

+  @retval EFI_OUT_OF_RESOURCES  Request failed due to lack of resources

 

 **/

 typedef

@@ -294,14 +294,14 @@ EFI_STATUS
   This function is called for all the PCI controllers that the PCI 

   bus driver finds. Can be used to Preprogram the controller.

 

-  @param  This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance

-  @param  RootBridgeHandle The PCI Root Bridge handle

-  @param  PciBusAddress Address of the controller on the PCI bus

-  @param Phase The Phase during resource allocation

+  @param  This                  The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance

+  @param  RootBridgeHandle      The PCI Root Bridge handle

+  @param  PciBusAddress         Address of the controller on the PCI bus

+  @param  Phase                 The Phase during resource allocation

 

-  @retval  EFI_SUCCESS Success

-  @retval  EFI_INVALID_PARAMETER RootBridgeHandle is invalid

-  @retval  EFI_DEVICE_ERROR Device pre-initialization failed due to hardware error.

+  @retval EFI_SUCCESS           Success

+  @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid

+  @retval EFI_DEVICE_ERROR      Device pre-initialization failed due to hardware error.

 

 **/

 typedef