Formalize comments for Protocols and PPIs.

1. Use doxygen format for Protocol/PPI data structure
2. Remove doxygen comments for function elements in Protocol/Ppi
3. Use doxygen format for data elements in Protocol/Ppi, and add missing comments where necessary
4. PEI Services Table is also updated accordingly.

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

1 files changed, 9 insertions, 7 deletions

diff --git a/MdePkg/Include/Protocol/ScsiPassThruExt.h b/MdePkg/Include/Protocol/ScsiPassThruExt.h
index 39b2ba5907..d63f056c5a 100644
--- a/MdePkg/Include/Protocol/ScsiPassThruExt.h
+++ b/MdePkg/Include/Protocol/ScsiPassThruExt.h
@@ -308,14 +308,16 @@ EFI_STATUS
   IN OUT UINT8                                     **Target

   );          

 

-/**  

-  @par Protocol Description:

-  The EFI_EXT_SCSI_PASS_THRU_PROTOCOL provides information about a SCSI channel 

-  and the ability to send SCI Request Packets to any SCSI device attached to 

-  that SCSI channel. The information includes the Target ID of the host controller 

-  on the SCSI channel and the attributes of the SCSI channel.

-**/  

+///

+/// The EFI_EXT_SCSI_PASS_THRU_PROTOCOL provides information about a SCSI channel 

+/// and the ability to send SCI Request Packets to any SCSI device attached to 

+/// that SCSI channel. The information includes the Target ID of the host controller 

+/// on the SCSI channel and the attributes of the SCSI channel.

+///

 struct _EFI_EXT_SCSI_PASS_THRU_PROTOCOL {

+  ///

+  /// A pointer to the EFI_EXT_SCSI_PASS_THRU_MODE data for this SCSI channel.

+  ///

   EFI_EXT_SCSI_PASS_THRU_MODE                *Mode;

   EFI_EXT_SCSI_PASS_THRU_PASSTHRU            PassThru;

   EFI_EXT_SCSI_PASS_THRU_GET_NEXT_TARGET_LUN GetNextTargetLun;