Changeset a6add7a in mainline for uspace/drv/usbmouse/mouse.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/drv/usbmouse/mouse.h (modified) (1 diff)

uspace/drv/usbmouse/mouse.h

@@ -43 +43 @@
 #define NAME "usbmouse"
 
+/** Container for USB mouse device. */
 typedef struct {
+        /** Generic device container. */
         ddf_dev_t *device;
+        /** Function representing the device. */
         ddf_fun_t *mouse_fun;
+        /** Representation of connection to the device. */
         usb_device_connection_t wire;
+        /** Default (zero) control pipe. */
         usb_endpoint_pipe_t ctrl_pipe;
+        /** Polling (in) pipe. */
         usb_endpoint_pipe_t poll_pipe;
+        /** Polling interval in microseconds. */
         suseconds_t poll_interval_us;
+        /** IPC phone to console (consumer). */
         int console_phone;
 } usb_mouse_t;