[tuxdroid-svn] r419 - daemon/trunk/libs

[neimad <c2m...@c2...>]

Author: neimad
Date: 2007-06-23 21:13:19 +0200 (Sat, 23 Jun 2007)
New Revision: 419

Modified:
   daemon/trunk/libs/USBDaemon_usb.c
Log:
* All function comments now follow the doxygen style.


Modified: daemon/trunk/libs/USBDaemon_usb.c
===================================================================
--- daemon/trunk/libs/USBDaemon_usb.c	2007-06-23 19:08:26 UTC (rev 418)
+++ daemon/trunk/libs/USBDaemon_usb.c	2007-06-23 19:13:19 UTC (rev 419)
@@ -33,11 +33,14 @@
 struct usb_device *tux_device = NULL;
 usb_connection_status_t usb_connection_status = USB_DISCONNECTED;
 
-/************************************************************************ */
-
-/* usb_find_TuxDroid() */
-
-/************************************************************************ */
+/**
+ * Find a Tux droid.
+ *
+ * Searches all USB buses and returns the first device matching Tux
+ * vendor and product id.
+ *
+ * @return Device found or NULL if none
+ */
 struct usb_device *usb_find_TuxDroid(void)
 {
     struct usb_bus *bus;
@@ -56,11 +59,13 @@
     return NULL;
 }
 
-/************************************************************************ */
-
-/* usb_open_TuxDroid() */
-
-/************************************************************************ */
+/**
+ * Open the specified Tux device.
+ *
+ * @param tux_dev  Tux device (as returned by usb_find_TuxDroid())
+ *
+ * @return Handle on the device if successful, NULL otherwise
+ */
 static struct usb_dev_handle *usb_open_TuxDroid(struct usb_device *tux_dev)
 {
     usb_dev_handle *tux_hdl;
@@ -90,7 +95,6 @@
     return tux_hdl;
 }
 
-
 /**
  * Close a Tux droid previously opened with usb_open_TuxDroid().
  */
@@ -108,7 +112,7 @@
 /**
  * Capture a Tux droid.
  *
- * \return 1 if successful, 0 otherwise
+ * @return 1 if successful, 0 otherwise
  */
 int usb_capture_TuxDroid(void)
 {