Changeset a6add7a in mainline for uspace/lib/usb/include/usb/dp.h

Timestamp:

2011-03-04T23:35:22Z (14 years ago)

Author:

Vojtech Horky <vojtechhorky@…>

Branches:

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

Children:

960bee9

Parents:

d78a32f

Message:

Comment and documentation fixes

In the process also removed several functions that are no longer
needed.

This commit shall not affect functionality in any way.

File:

• uspace/lib/usb/include/usb/dp.h (modified) (3 diffs)

uspace/lib/usb/include/usb/dp.h

@@ -31 +31 @@
  */
 /** @file
- * @brief USB descriptor parser.
+ * USB descriptor parser.
  */
 #ifndef LIBUSB_DP_H_
@@ -40 +40 @@
 #include <usb/descriptor.h>
 
+/** USB descriptors nesting.
+ * The nesting describes the logical tree USB descriptors form
+ * (e.g. that endpoint descriptor belongs to interface or that
+ * interface belongs to configuration).
+ *
+ * See usb_descriptor_type_t for descriptor constants.
+ */
 typedef struct {
+        /** Child descriptor id. */
         int child;
+        /** Parent descriptor id. */
         int parent;
 } usb_dp_descriptor_nesting_t;
@@ -47 +56 @@
 extern usb_dp_descriptor_nesting_t usb_dp_standard_descriptor_nesting[];
 
+/** Descriptor parser structure. */
 typedef struct {
+        /** Used descriptor nesting. */
         usb_dp_descriptor_nesting_t *nesting;
 } usb_dp_parser_t;
 
+/** Descriptor parser data. */
 typedef struct {
+        /** Data to be parsed. */
         uint8_t *data;
+        /** Size of input data in bytes. */
         size_t size;
+        /** Custom argument. */
         void *arg;
 } usb_dp_parser_data_t;