Changeset 3b77628 in mainline for uspace/lib/usb/src

Timestamp:

2011-01-24T11:58:24Z (14 years ago)

Author:

Vojtech Horky <vojtechhorky@…>

Branches:

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

Children:

afc4fbb

Parents:

0cfc68f0

Message:

Doxygen comment fixes

Mainly proper subgrouping and some missing @param comments.

Location:

uspace/lib/usb/src

Files:

• addrkeep.c (modified) (1 diff)
• class.c (modified) (1 diff)
• debug.c (modified) (1 diff)
• dp.c (modified) (1 diff)
• drvpsync.c (modified) (1 diff)
• hcdhubd.c (modified) (1 diff)
• hcdhubd_private.h (modified) (1 diff)
• hcdrv.c (modified) (1 diff)
• hidparser.c (modified) (1 diff)
• localdrv.c (modified) (1 diff)
• recognise.c (modified) (4 diffs)
• remotedrv.c (modified) (1 diff)
• usb.c (modified) (1 diff)
• usbdrv.c (modified) (1 diff)
• usbdrvreq.c (modified) (2 diffs)

uspace/lib/usb/src/addrkeep.c

@@ -27 +27 @@
  */
 
-/** @addtogroup libusb usb
+/** @addtogroup libusb
  * @{
  */

uspace/lib/usb/src/class.c

@@ -27 +27 @@
  */
 
-/** @addtogroup libusb usb
+/** @addtogroup libusb
  * @{
  */

uspace/lib/usb/src/debug.c

@@ -27 +27 @@
  */
 
-/** @addtogroup libusb usb
+/** @addtogroup libusb
  * @{
  */

uspace/lib/usb/src/dp.c

@@ -45 +45 @@
  * @param data Parser data.
  * @param ptr Pointer to be verified.
- * @return Whether @ptr points inside <code>data->data</code> field.
+ * @return Whether @p ptr points inside <code>data->data</code> field.
  */
 static bool is_valid_descriptor_pointer(usb_dp_parser_data_t *data,

uspace/lib/usb/src/drvpsync.c

@@ -27 +27 @@
  */
 
-/** @addtogroup libusb usb
+/** @addtogroup libusb
  * @{
  */

uspace/lib/usb/src/hcdhubd.c

@@ -27 +27 @@
  */
 
-/** @addtogroup libusb usb
+/** @addtogroup libusb
  * @{
  */

uspace/lib/usb/src/hcdhubd_private.h

@@ -27 +27 @@
  */
 
-/** @addtogroup libusb usb
+/** @addtogroup libusb
  * @{
  */

uspace/lib/usb/src/hcdrv.c

@@ -27 +27 @@
  */
 
-/** @addtogroup libusb usb
+/** @addtogroup libusb
  * @{
  */

uspace/lib/usb/src/hidparser.c

@@ -27 +27 @@
  */
 
-/** @addtogroup libusb usb
+/** @addtogroup libusb
  * @{
  */

uspace/lib/usb/src/localdrv.c

@@ -27 +27 @@
  */
 
-/** @addtogroup libusb usb
+/** @addtogroup libusb
  * @{
  */

uspace/lib/usb/src/recognise.c

@@ -27 +27 @@
  */
 
-/** @addtogroup libusb usb
+/** @addtogroup libusb
  * @{
  */
@@ -39 +39 @@
 #include <errno.h>
 
+/** Callback for getting host controller handle.
+ *
+ * @param dev Device in question.
+ * @param[out] handle Devman handle of the host controller.
+ * @return Error code.
+ */
 static int usb_iface_get_hc_handle(device_t *dev, devman_handle_t *handle)
 {
@@ -237 +243 @@
  * @param matches Match ids list to add matches to.
  * @param address USB address of the attached device.
+ * @param config_count Number of configurations the device has.
  * @return Error code.
  */
@@ -342 +349 @@
 /** Probe for device kind and register it in devman.
  *
- * @param hc Open phone to the host controller.
- * @param parent Parent device.
- * @param address Address of the (unknown) attached device.
+ * @param[in] hc Open phone to the host controller.
+ * @param[in] parent Parent device.
+ * @param[in] address Address of the (unknown) attached device.
+ * @param[out] child_handle Handle of the child device.
  * @return Error code.
  */

uspace/lib/usb/src/remotedrv.c

@@ -27 +27 @@
  */
 
-/** @addtogroup libusb usb
+/** @addtogroup libusb
  * @{
  */

uspace/lib/usb/src/usb.c

@@ -27 +27 @@
  */
 
-/** @addtogroup libusb usb
+/** @addtogroup libusb
  * @{
  */

uspace/lib/usb/src/usbdrv.c

@@ -27 +27 @@
  */
 
-/** @addtogroup libusb usb
+/** @addtogroup libusb
  * @{
  */

uspace/lib/usb/src/usbdrvreq.c

@@ -27 +27 @@
  */
 
-/** @addtogroup libusb usb
+/** @addtogroup libusb
  * @{
  */
@@ -188 +188 @@
  * @param[in] phone Open phone to HC driver.
  * @param[in] old_address Current address.
- * @param[in] address Address to be set.
+ * @param[in] new_address Address to be set.
  * @return Error code.
  */