sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Formalize comments for Protocols and PPIs.

Browse Source 
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
This commit is contained in:
xli24
2008-10-13 02:54:29 +00:00
parent 66eebcf94f
commit 44717a398f
103 changed files with 576 additions and 1012 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
MdePkg/Include/Protocol/Usb2HostController.h
View File

@@ -553,16 +553,14 @@ EFI_STATUS
IN EFI_USB_PORT_FEATURE PortFeature
);
/**
@par Protocol Description:
The EFI_USB2_HC_PROTOCOL provides USB host controller management, basic
data transactions over a USB bus, and USB root hub access. A device driver
that wishes to manage a USB bus in a system retrieves the EFI_USB2_HC_PROTOCOL
instance that is associated with the USB bus to be managed. A device handle
for a USB host controller will minimally contain an EFI_DEVICE_PATH_PROTOCOL
instance, and an EFI_USB2_HC_PROTOCOL instance.
**/
///
/// The EFI_USB2_HC_PROTOCOL provides USB host controller management, basic
/// data transactions over a USB bus, and USB root hub access. A device driver
/// that wishes to manage a USB bus in a system retrieves the EFI_USB2_HC_PROTOCOL
/// instance that is associated with the USB bus to be managed. A device handle
/// for a USB host controller will minimally contain an EFI_DEVICE_PATH_PROTOCOL
/// instance, and an EFI_USB2_HC_PROTOCOL instance.
///
struct _EFI_USB2_HC_PROTOCOL {
EFI_USB2_HC_PROTOCOL_GET_CAPABILITY GetCapability;
EFI_USB2_HC_PROTOCOL_RESET Reset;