Formalize comments for Protocols and PPIs.

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

diff --git a/MdePkg/Include/Protocol/ScsiPassThru.h b/MdePkg/Include/Protocol/ScsiPassThru.h
index f40619311817392f832333566089a7a8d811d4a3..ee498e0ec32e35b9a788d691a94e6aba1de455c2 100644 (file)
--- a/MdePkg/Include/Protocol/ScsiPassThru.h
+++ b/MdePkg/Include/Protocol/ScsiPassThru.h
@@ -146,8 +146,7 @@ EFI_STATUS
   IN UINT64                                               Lun,\r
   IN OUT EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET           *Packet,\r
   IN EFI_EVENT                                            Event   OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Used to retrieve the list of legal Target IDs for SCSI devices \r
@@ -179,8 +178,7 @@ EFI_STATUS
   IN EFI_SCSI_PASS_THRU_PROTOCOL            *This,\r
   IN OUT UINT32                             *Target,\r
   IN OUT UINT64                             *Lun\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Used to allocate and build a device path node for a SCSI device \r
@@ -216,8 +214,7 @@ EFI_STATUS
   IN     UINT32                             Target,\r
   IN     UINT64                             Lun,\r
   IN OUT EFI_DEVICE_PATH_PROTOCOL           **DevicePath\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Used to translate a device path node to a Target ID and LUN.\r
@@ -249,8 +246,7 @@ EFI_STATUS
   IN  EFI_DEVICE_PATH_PROTOCOL              *DevicePath,\r
   OUT UINT32                                *Target,\r
   OUT UINT64                                *Lun\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Resets a SCSI channel.This operation resets all the \r
@@ -271,8 +267,7 @@ typedef
 EFI_STATUS\r
 (EFIAPI *EFI_SCSI_PASS_THRU_RESET_CHANNEL)(\r
   IN EFI_SCSI_PASS_THRU_PROTOCOL             *This\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Resets a SCSI device that is connected to a SCSI channel.\r
@@ -299,41 +294,19 @@ EFI_STATUS
   IN EFI_SCSI_PASS_THRU_PROTOCOL             *This,\r
   IN UINT32                                  Target,\r
   IN UINT64                                  Lun\r
-  )\r
-;\r
+  );\r
 \r
-/**  \r
-  @par Protocol Description:\r
-  The EFI_SCSI_PASS_THRU_PROTOCOL provides information about a SCSI channel and\r
-  the ability to send SCI Request Packets to any SCSI device attached to that SCSI channel. The\r
-  information includes the Target ID of the host controller on the SCSI channel, the attributes of\r
-  the SCSI channel, the printable name for the SCSI controller, and the printable name of the\r
-  SCSI channel.\r
-\r
-  @param Mode \r
-  A pointer to the EFI_SCSI_PASS_THRU_MODE data for this SCSI channel.\r
-\r
-  @param PassThru \r
-  Sends a SCSI Request Packet to a SCSI device that is connected to the SCSI channel.\r
-\r
-  @param GetNextDevice \r
-  Used to retrieve the list of legal Target IDs and LUNs for the\r
-  SCSI devices on a SCSI channel. \r
-\r
-  @param BuildDevicePath \r
-  Used to allocate and build a device path node for a SCSI device on a SCSI channel.\r
-\r
-  @param GetTargetLun \r
-  Used to translate a device path node to a Target ID and LUN.\r
-\r
-  @param ResetChannel \r
-  Resets the SCSI channel. This operation resets all the SCSI\r
-  devices connected to the SCSI channel.\r
-\r
-  @param ResetTarget \r
-  Resets a SCSI device that is connected to the SCSI channel. \r
-**/\r
+///\r
+/// The EFI_SCSI_PASS_THRU_PROTOCOL provides information about a SCSI channel and\r
+/// the ability to send SCI Request Packets to any SCSI device attached to that SCSI channel. The\r
+/// information includes the Target ID of the host controller on the SCSI channel, the attributes of\r
+/// the SCSI channel, the printable name for the SCSI controller, and the printable name of the\r
+/// SCSI channel.\r
+///\r
 struct _EFI_SCSI_PASS_THRU_PROTOCOL {\r
+  ///\r
+  /// A pointer to the EFI_SCSI_PASS_THRU_MODE data for this SCSI channel.\r
+  ///\r
   EFI_SCSI_PASS_THRU_MODE               *Mode;\r
   EFI_SCSI_PASS_THRU_PASSTHRU           PassThru;\r
   EFI_SCSI_PASS_THRU_GET_NEXT_DEVICE    GetNextDevice;\r