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

diff --git a/MdePkg/Include/Protocol/Usb2HostController.h b/MdePkg/Include/Protocol/Usb2HostController.h
index ec2415d1fa4d3fd62a38bec6e7f02b07199241b4..d8b1f85a818c050db3e3ba7808a21cf5b9fa7cca 100644 (file)
--- a/MdePkg/Include/Protocol/Usb2HostController.h
+++ b/MdePkg/Include/Protocol/Usb2HostController.h
@@ -141,43 +141,38 @@ EFI_STATUS
   );\r
 \r
 /**\r
-\r
-  @param EfiUsbHcStateHalt          The host controller is in halt\r
-                                    state. No USB transactions can occur\r
-                                    while in this state. The host\r
-                                    controller can enter this state for\r
-                                    three reasons: 1) After host\r
-                                    controller hardware reset. 2)\r
-                                    Explicitly set by software. 3)\r
-                                    Triggered by a fatal error such as\r
-                                    consistency check failure.\r
-\r
-\r
-  @param EfiUsbHcStateOperational   The host controller is in an\r
-                                    operational state. When in\r
-                                    this state, the host\r
-                                    controller can execute bus\r
-                                    traffic. This state must be\r
-                                    explicitly set to enable the\r
-                                    USB bus traffic.\r
-\r
-\r
-  @param EfiUsbHcStateSuspend       The host controller is in the\r
-                                    suspend state. No USB\r
-                                    transactions can occur while in\r
-                                    this state. The host controller\r
-                                    enters this state for the\r
-                                    following reasons: 1) Explicitly\r
-                                    set by software. 2) Triggered\r
-                                    when there is no bus traffic for\r
-                                    3 microseconds.\r
-\r
+  Enumration value for status of USB HC.\r
 **/\r
 typedef enum {\r
-  EfiUsbHcStateHalt,\r
-  EfiUsbHcStateOperational,\r
-  EfiUsbHcStateSuspend,\r
-  EfiUsbHcStateMaximum\r
+  EfiUsbHcStateHalt,                ///< The host controller is in halt\r
+                                    ///< state. No USB transactions can occur\r
+                                    ///< while in this state. The host\r
+                                    ///< controller can enter this state for\r
+                                    ///< three reasons: 1) After host\r
+                                    ///< controller hardware reset. 2)\r
+                                    ///< Explicitly set by software. 3)\r
+                                    ///< Triggered by a fatal error such as\r
+                                    ///< consistency check failure.\r
+                                    \r
+  EfiUsbHcStateOperational,         ///< The host controller is in an\r
+                                    ///< operational state. When in\r
+                                    ///< this state, the host\r
+                                    ///< controller can execute bus\r
+                                    ///< traffic. This state must be\r
+                                    ///< explicitly set to enable the\r
+                                    ///< USB bus traffic.\r
+                                    \r
+  EfiUsbHcStateSuspend,             ///< The host controller is in the\r
+                                    ///< suspend state. No USB\r
+                                    ///< transactions can occur while in\r
+                                    ///< this state. The host controller\r
+                                    ///< enters this state for the\r
+                                    ///< following reasons: 1) Explicitly\r
+                                    ///< set by software. 2) Triggered\r
+                                    ///< when there is no bus traffic for\r
+                                    ///< 3 microseconds.\r
+                                    \r
+  EfiUsbHcStateMaximum              ///< Maximum value for enumration value of HC status.\r
 } EFI_USB_HC_STATE;\r
 \r
 /**\r