From 8048b3f575142b793843a8fc8f31f47ae8eaad06 Mon Sep 17 00:00:00 2001 From: klu2 Date: Sun, 28 Sep 2008 06:59:47 +0000 Subject: [PATCH] Use doxygen style comments for enumration value. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6062 6f19259b-4bc3-4df7-8a09-765794883524 --- MdePkg/Include/Protocol/Usb2HostController.h | 65 +++++++++----------- 1 file changed, 30 insertions(+), 35 deletions(-) diff --git a/MdePkg/Include/Protocol/Usb2HostController.h b/MdePkg/Include/Protocol/Usb2HostController.h index ec2415d1fa..d8b1f85a81 100644 --- a/MdePkg/Include/Protocol/Usb2HostController.h +++ b/MdePkg/Include/Protocol/Usb2HostController.h @@ -141,43 +141,38 @@ EFI_STATUS ); /** - - @param EfiUsbHcStateHalt The host controller is in halt - state. No USB transactions can occur - while in this state. The host - controller can enter this state for - three reasons: 1) After host - controller hardware reset. 2) - Explicitly set by software. 3) - Triggered by a fatal error such as - consistency check failure. - - - @param EfiUsbHcStateOperational The host controller is in an - operational state. When in - this state, the host - controller can execute bus - traffic. This state must be - explicitly set to enable the - USB bus traffic. - - - @param EfiUsbHcStateSuspend The host controller is in the - suspend state. No USB - transactions can occur while in - this state. The host controller - enters this state for the - following reasons: 1) Explicitly - set by software. 2) Triggered - when there is no bus traffic for - 3 microseconds. - + Enumration value for status of USB HC. **/ typedef enum { - EfiUsbHcStateHalt, - EfiUsbHcStateOperational, - EfiUsbHcStateSuspend, - EfiUsbHcStateMaximum + EfiUsbHcStateHalt, ///< The host controller is in halt + ///< state. No USB transactions can occur + ///< while in this state. The host + ///< controller can enter this state for + ///< three reasons: 1) After host + ///< controller hardware reset. 2) + ///< Explicitly set by software. 3) + ///< Triggered by a fatal error such as + ///< consistency check failure. + + EfiUsbHcStateOperational, ///< The host controller is in an + ///< operational state. When in + ///< this state, the host + ///< controller can execute bus + ///< traffic. This state must be + ///< explicitly set to enable the + ///< USB bus traffic. + + EfiUsbHcStateSuspend, ///< The host controller is in the + ///< suspend state. No USB + ///< transactions can occur while in + ///< this state. The host controller + ///< enters this state for the + ///< following reasons: 1) Explicitly + ///< set by software. 2) Triggered + ///< when there is no bus traffic for + ///< 3 microseconds. + + EfiUsbHcStateMaximum ///< Maximum value for enumration value of HC status. } EFI_USB_HC_STATE; /** -- 2.39.2