Changeset 70e5ad5 in mainline for uspace/drv/vhc/hub/hub.h

Timestamp:

2010-12-16T11:12:31Z (13 years ago)

Author:

Vojtech Horky <vojtechhorky@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

11658b64, 5863a95

Parents:

cea3fca

Message:

More doxygen comments

File:

• uspace/drv/vhc/hub/hub.h (modified) (3 diffs)

uspace/drv/vhc/hub/hub.h

@@ -31 +31 @@
  */
 /** @file
- * @brief
+ * @brief Representation of an USB hub.
  */
 #ifndef VHC_HUB_HUB_H_
@@ -72 +72 @@
 /** Hub port information. */
 typedef struct {
+        /** Custom pointer to connected device. */
         void *connected_device;
+        /** Port index (one based). */
         size_t index;
+        /** Port state. */
         hub_port_state_t state;
+        /** Status change bitmap. */
         uint16_t status_change;
 } hub_port_t;
@@ -80 +84 @@
 /** Hub device type. */
 typedef struct {
+        /** Hub ports. */
         hub_port_t ports[HUB_PORT_COUNT];
+        /** Custom hub data. */
         void *custom_data;
+        /** Access guard to the whole hub. */
         fibril_mutex_t guard;
 } hub_t;