summaryrefslogtreecommitdiff
path: root/MdePkg/Include/Protocol/UsbIo.h
diff options
context:
space:
mode:
authorxli24 <xli24@6f19259b-4bc3-4df7-8a09-765794883524>2008-10-13 02:54:29 +0000
committerxli24 <xli24@6f19259b-4bc3-4df7-8a09-765794883524>2008-10-13 02:54:29 +0000
commit44717a398fddc4df1f4aeaa70bcd7a043187ed34 (patch)
treeb41f68d9d59c300d71efeeba5a12acc1bbcfb593 /MdePkg/Include/Protocol/UsbIo.h
parent66eebcf94f14a0888a09f6fe5aca16563411becf (diff)
downloadedk2-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/UsbIo.h')
-rw-r--r--MdePkg/Include/Protocol/UsbIo.h15
1 files changed, 7 insertions, 8 deletions
diff --git a/MdePkg/Include/Protocol/UsbIo.h b/MdePkg/Include/Protocol/UsbIo.h
index 55fd3b8d37..0c5bd70445 100644
--- a/MdePkg/Include/Protocol/UsbIo.h
+++ b/MdePkg/Include/Protocol/UsbIo.h
@@ -473,14 +473,13 @@ EFI_STATUS
OUT UINT16 *TableSize
);
-/**
- @par Protocol Description:
- The EFI_USB_IO_PROTOCOL provides four basic transfers types described
- in the USB 1.1 Specification. These include control transfer, interrupt
- transfer, bulk transfer and isochronous transfer. The EFI_USB_IO_PROTOCOL
- also provides some basic USB device/controller management and configuration
- interfaces. A USB device driver uses the services of this protocol to manage USB devices.
-**/
+///
+/// The EFI_USB_IO_PROTOCOL provides four basic transfers types described
+/// in the USB 1.1 Specification. These include control transfer, interrupt
+/// transfer, bulk transfer and isochronous transfer. The EFI_USB_IO_PROTOCOL
+/// also provides some basic USB device/controller management and configuration
+/// interfaces. A USB device driver uses the services of this protocol to manage USB devices.
+///
struct _EFI_USB_IO_PROTOCOL {
//
// IO transfer