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

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

Author: neimad
Date: 2007-06-16 13:58:33 +0200 (Sat, 16 Jun 2007)
New Revision: 378

Modified:
   daemon/trunk/libs/USBDaemon_usb_readWrite.c
Log:
* "Fixed" function comments: merely repeating their name if of no use
  whatsoever. Not sure about some things, which explains the FIXMEs.

* Deleted "I N C L U D E S" and "F U N C T I O N S" section comments.
  I think we can all see what is what, right ? ;-)


Modified: daemon/trunk/libs/USBDaemon_usb_readWrite.c
===================================================================
--- daemon/trunk/libs/USBDaemon_usb_readWrite.c	2007-06-16 11:38:26 UTC (rev 377)
+++ daemon/trunk/libs/USBDaemon_usb_readWrite.c	2007-06-16 11:58:33 UTC (rev 378)
@@ -21,7 +21,6 @@
 
 /* $Id$ */
 
-/*_____________________ I N C L U D E S____________________________________ */
 #include <stdio.h>
 #include "USBDaemon_usb_enum.h"
 #include "USBDaemon_globals.h"
@@ -30,11 +29,13 @@
 #include "USBDaemon_tcp_server.h"
 #include "USBDaemon_usb_readWrite.h"
 
-/*_____________________ F U N C T I O N S __________________________________*/
-
-/************************************************************************ */
-/* usb_get_status_TuxDroid() */
-/************************************************************************ */
+/**
+ * Get Tux droid's status.
+ *
+ * FIXME: the status of *what* exactly ?
+ * FIXME: "getting" something and not actually returning anything
+ *        is weird; "updating" would be more correct.
+ */
 void usb_get_status_TuxDroid(void)
 {
     const unsigned char cmd_send[5] = { 0x01, 0x01, 0x00, 0x00, 0x00 };
@@ -79,9 +80,14 @@
     }
 }
 
-/************************************************************************ */
-/* usb_write_TuxDroid() */
-/************************************************************************ */
+/**
+ * Send data to Tux droid over usb.
+ * FIXME: the whole cmd_status_flag thing is clunky.
+ *
+ * @param[in] data  Data to send
+ *
+ * @return Acknowledgement (ACK_xxx), may be success or error
+ */
 unsigned char usb_write_TuxDroid(unsigned char data[TUX_SEND_LENGTH])
 {
     int idx;