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

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

diff --git a/MdePkg/Include/Protocol/IdeControllerInit.h b/MdePkg/Include/Protocol/IdeControllerInit.h
index beaac30e5ffd7b9c3f34e83258f5fe1c3a323709..0249055bc5017783ccec55c22fbcded02a63c071 100644 (file)
--- a/MdePkg/Include/Protocol/IdeControllerInit.h
+++ b/MdePkg/Include/Protocol/IdeControllerInit.h
@@ -263,18 +263,14 @@ typedef union {
 /**\r
   Returns the information about the specified IDE channel. \r
 \r
-  @param  This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. \r
-  \r
-  @param  Channel Zero-based channel number.\r
-  \r
-  @param  Enabled TRUE if this channel is enabled. Disabled channels are not scanned \r
-  to see if any devices are present.\r
-  \r
-  @param  MaxDevices The maximum number of IDE devices that the bus driver \r
-  can expect on this channel. \r
-\r
-  @retval EFI_SUCCESS Information was returned without any errors.\r
-  \r
+  @param  This                  Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+  @param  Channel               Zero-based channel number.\r
+  @param  Enabled               TRUE if this channel is enabled. Disabled channels are not scanned\r
+                                to see if any devices are present.\r
+  @param  MaxDevices            The maximum number of IDE devices that the bus driver\r
+                                can expect on this channel.\r
+\r
+  @retval EFI_SUCCESS           Information was returned without any errors.\r
   @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r
 \r
 **/\r
@@ -291,19 +287,14 @@ EFI_STATUS
   The notifications from the IDE bus driver that it is about to enter a certain \r
   phase of the IDE channel enumeration process. \r
 \r
-  @param  This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. \r
-  \r
-  @param  Phase The phase during enumeration. \r
-  \r
-  @param  Channel Zero-based channel number.\r
+  @param  This                  Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+  @param  Phase                 The phase during enumeration.\r
+  @param  Channel               Zero-based channel number.\r
 \r
-  @retval EFI_SUCCESS The notification was accepted without any errors.\r
-  \r
-  @retval EFI_NOT_SUPPORTED Phase is not supported.\r
-  \r
+  @retval EFI_SUCCESS           The notification was accepted without any errors.\r
+  @retval EFI_NOT_SUPPORTED     Phase is not supported.\r
   @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r
-  \r
-  @retval EFI_NOT_READY This phase cannot be entered at this time.\r
+  @retval EFI_NOT_READY         This phase cannot be entered at this time.\r
 \r
 **/\r
 typedef \r
@@ -317,18 +308,14 @@ EFI_STATUS
 /**\r
   Submits the device information to the IDE controller driver. \r
 \r
-  @param  This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. \r
-  \r
-  @param  Channel Zero-based channel number.\r
-  \r
-  @param  Device Zero-based device number on the Channel.\r
-  \r
-  @param  IdentifyData The device¡¯s response to the ATA IDENTIFY_DEVICE command.\r
+  @param  This                  Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+  @param  Channel               Zero-based channel number.\r
+  @param  Device                Zero-based device number on the Channel.\r
+  @param  IdentifyData          The device¡¯s response to the ATA IDENTIFY_DEVICE command.\r
 \r
-  @retval EFI_SUCCESS The information was accepted without any errors.\r
-  \r
+  @retval EFI_SUCCESS           The information was accepted without any errors.\r
   @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r
-  Or Device is invalid.\r
+                                Or Device is invalid.\r
 \r
 **/\r
 typedef \r
@@ -343,19 +330,15 @@ EFI_STATUS
 /**\r
   Disqualifies specific modes for an IDE device. \r
 \r
-  @param  This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. \r
-  \r
-  @param  Channel Zero-based channel number.\r
-  \r
-  @param  Device Zero-based device number on the Channel.\r
-  \r
-  @param  BadModes The modes that the device does not support and that \r
-  should be disqualified.\r
-\r
-  @retval EFI_SUCCESS The modes were accepted without any errors.\r
-  \r
+  @param  This                  Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+  @param  Channel               Zero-based channel number.\r
+  @param  Device                Zero-based device number on the Channel.\r
+  @param  BadModes              The modes that the device does not support and that\r
+                                should be disqualified.\r
+\r
+  @retval EFI_SUCCESS           The modes were accepted without any errors.\r
   @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r
-  Or Device is invalid.\r
+                                Or Device is invalid.\r
 \r
 **/\r
 typedef\r
@@ -370,20 +353,15 @@ EFI_STATUS
 /**\r
   Returns the information about the optimum modes for the specified IDE device.\r
 \r
-  @param  This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. \r
-  \r
-  @param  Channel Zero-based channel number.\r
-  \r
-  @param  Device Zero-based device number on the Channel.\r
-  \r
-  @param  SupportedModes The optimum modes for the device. \r
+  @param  This                  Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+  @param  Channel               Zero-based channel number.\r
+  @param  Device                Zero-based device number on the Channel.\r
+  @param  SupportedModes        The optimum modes for the device.\r
 \r
-  @retval EFI_SUCCESS SupportedModes was returned.\r
-  \r
+  @retval EFI_SUCCESS           SupportedModes was returned.\r
   @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r
-  Or Device is invalid. Or SupportedModes is NULL.\r
-  \r
-  @retval EFI_NOT_READY Modes cannot be calculated due to a lack of data. \r
+                                Or Device is invalid. Or SupportedModes is NULL.\r
+  @retval EFI_NOT_READY         Modes cannot be calculated due to a lack of data.\r
 \r
 **/\r
 typedef\r
@@ -399,23 +377,17 @@ EFI_STATUS
   Commands the IDE controller driver to program the IDE controller hardware \r
   so that the specified device can operate at the specified mode. \r
 \r
-  @param  This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance. \r
-  \r
-  @param  Channel Zero-based channel number.\r
-  \r
-  @param  Device Zero-based device number on the Channel.\r
-  \r
-  @param  Modes The modes to set. \r
+  @param  This                  Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.\r
+  @param  Channel               Zero-based channel number.\r
+  @param  Device                Zero-based device number on the Channel.\r
+  @param  Modes                 The modes to set.\r
 \r
-  @retval EFI_SUCCESS The command was accepted without any errors.\r
-  \r
+  @retval EFI_SUCCESS           The command was accepted without any errors.\r
   @retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).\r
-  Or Device is invalid.\r
-  \r
-  @retval EFI_NOT_READY Modes cannot be set at this time due to lack of data.\r
-  \r
-  @retval EFI_DEVICE_ERROR Modes cannot be set due to hardware failure. \r
-  The IDE bus driver should not use this device.\r
+                                Or Device is invalid.\r
+  @retval EFI_NOT_READY         Modes cannot be set at this time due to lack of data.\r
+  @retval EFI_DEVICE_ERROR      Modes cannot be set due to hardware failure.\r
+                                The IDE bus driver should not use this device.\r
 \r
 **/\r
 typedef\r