diff options
author | xli24 <xli24@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-10-13 02:54:29 +0000 |
---|---|---|
committer | xli24 <xli24@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-10-13 02:54:29 +0000 |
commit | 44717a398fddc4df1f4aeaa70bcd7a043187ed34 (patch) | |
tree | b41f68d9d59c300d71efeeba5a12acc1bbcfb593 /MdePkg/Include/Protocol/ScsiPassThru.h | |
parent | 66eebcf94f14a0888a09f6fe5aca16563411becf (diff) | |
download | edk2-platforms-44717a398fddc4df1f4aeaa70bcd7a043187ed34.tar.xz |
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
Diffstat (limited to 'MdePkg/Include/Protocol/ScsiPassThru.h')
-rw-r--r-- | MdePkg/Include/Protocol/ScsiPassThru.h | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/MdePkg/Include/Protocol/ScsiPassThru.h b/MdePkg/Include/Protocol/ScsiPassThru.h index 1ff7a6dfbb..ee498e0ec3 100644 --- a/MdePkg/Include/Protocol/ScsiPassThru.h +++ b/MdePkg/Include/Protocol/ScsiPassThru.h @@ -296,15 +296,17 @@ EFI_STATUS IN UINT64 Lun
);
-/**
- @par Protocol Description:
- The EFI_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, the attributes of
- the SCSI channel, the printable name for the SCSI controller, and the printable name of the
- SCSI channel.
-**/
+///
+/// The EFI_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, the attributes of
+/// the SCSI channel, the printable name for the SCSI controller, and the printable name of the
+/// SCSI channel.
+///
struct _EFI_SCSI_PASS_THRU_PROTOCOL {
+ ///
+ /// A pointer to the EFI_SCSI_PASS_THRU_MODE data for this SCSI channel.
+ ///
EFI_SCSI_PASS_THRU_MODE *Mode;
EFI_SCSI_PASS_THRU_PASSTHRU PassThru;
EFI_SCSI_PASS_THRU_GET_NEXT_DEVICE GetNextDevice;
|