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

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

Author: jaguarondi
Date: 2007-11-06 15:21:56 +0100 (Tue, 06 Nov 2007)
New Revision: 659

Modified:
   daemon/trunk/libs/USBDaemon_command_tux.h
   daemon/trunk/libs/USBDaemon_globals.h
   daemon/trunk/libs/USBDaemon_log.c
   daemon/trunk/libs/USBDaemon_pidfile.c
   daemon/trunk/libs/USBDaemon_tcp_server.c
   daemon/trunk/libs/USBDaemon_usb.c
Log:
* Consistency on doxygen comments.


Modified: daemon/trunk/libs/USBDaemon_command_tux.h
===================================================================
--- daemon/trunk/libs/USBDaemon_command_tux.h	2007-11-06 13:59:47 UTC (rev 658)
+++ daemon/trunk/libs/USBDaemon_command_tux.h	2007-11-06 14:21:56 UTC (rev 659)
@@ -1,4 +1,3 @@
-
 /*
 * Tux Droid - USB Daemon
 * Copyright (C) 2007 C2ME Sa <rem...@c2...>

Modified: daemon/trunk/libs/USBDaemon_globals.h
===================================================================
--- daemon/trunk/libs/USBDaemon_globals.h	2007-11-06 13:59:47 UTC (rev 658)
+++ daemon/trunk/libs/USBDaemon_globals.h	2007-11-06 14:21:56 UTC (rev 659)
@@ -1,4 +1,3 @@
-
 /*
 * Tux Droid - USB Daemon
 * Copyright (C) 2007 C2ME Sa <rem...@c2...>

Modified: daemon/trunk/libs/USBDaemon_log.c
===================================================================
--- daemon/trunk/libs/USBDaemon_log.c	2007-11-06 13:59:47 UTC (rev 658)
+++ daemon/trunk/libs/USBDaemon_log.c	2007-11-06 14:21:56 UTC (rev 659)
@@ -48,11 +48,11 @@
 static bool log_opened;
 
 /**
- * @brief Open the log.
+ * Open the log.
  *
- * @param[in] target  Logging target
+ * /param[in] target  Logging target
  *
- * @return true if successfull, false otherwise
+ * /return true if successfull, false otherwise
  */
 bool log_open(log_target_t target)
 {
@@ -82,7 +82,7 @@
 }
 
 /**
- * @brief Close the log.
+ * Close the log.
  */
 void log_close(void)
 {
@@ -108,9 +108,9 @@
 }
 
 /**
- * @brief Set the logging level.
+ * Set the logging level.
  *
- * @param[in] new_level  New logging level
+ * /param[in] new_level  New logging level
  */
 void log_set_level(log_level_t new_level)
 {
@@ -119,9 +119,9 @@
 }
 
 /**
- * @brief Get the logging level.
+ * Get the logging level.
  *
- * @return current logging level
+ * /return current logging level
  */
 log_level_t log_get_level(void)
 {
@@ -129,16 +129,16 @@
 }
 
 /**
- * @brief Log formatted message at the specified level.
+ * Log formatted message at the specified level.
  *
- * @param[in] at_level  Level to log the message at
- * @param[in] fmt       Message format
- * @param[in] ...       Optional message data
+ * /param[in] at_level  Level to log the message at
+ * /param[in] fmt       Message format
+ * /param[in] ...       Optional message data
  *
  * If the priority of the specifed level is lower than the priority
  * of the current logging level, the message is silently dropped.
  *
- * @return true if successful, false otherwise
+ * /return true if successful, false otherwise
  */
 bool log_text(log_level_t at_level, const char *fmt, ...)
 {

Modified: daemon/trunk/libs/USBDaemon_pidfile.c
===================================================================
--- daemon/trunk/libs/USBDaemon_pidfile.c	2007-11-06 13:59:47 UTC (rev 658)
+++ daemon/trunk/libs/USBDaemon_pidfile.c	2007-11-06 14:21:56 UTC (rev 659)
@@ -44,9 +44,9 @@
 /************************************************************************ */
 
 /**
- * @brief Read the pid from the pid file.
+ * Read the pid from the pid file.
  *
- * @return 0 if either there's no pid file, it's empty or no pid can be read
+ * /return 0 if either there's no pid file, it's empty or no pid can be read
  */
 int read_pid(void)
 {
@@ -63,9 +63,9 @@
 }
 
 /**
- * @brief Check existence of the process whose pid is in the pid file.
+ * Check existence of the process whose pid is in the pid file.
  *
- * @return 1 if the process exists, 0 otherwise
+ * /return 1 if the process exists, 0 otherwise
  */
 int check_pid(void)
 {
@@ -83,9 +83,9 @@
 }
 
 /**
- * @brief Write the current process' pid to the pid file.
+ * Write the current process' pid to the pid file.
  *
- * @return Pid written if successful, 0 otherwise
+ * /return Pid written if successful, 0 otherwise
  */
 int write_pid(void)
 {
@@ -131,9 +131,9 @@
 }
 
 /**
- * @brief Delete the pid file.
+ * Delete the pid file.
  *
- * @return result from unkink(2)
+ * /return result from unkink(2)
  */
 int remove_pid(void)
 {

Modified: daemon/trunk/libs/USBDaemon_tcp_server.c
===================================================================
--- daemon/trunk/libs/USBDaemon_tcp_server.c	2007-11-06 13:59:47 UTC (rev 658)
+++ daemon/trunk/libs/USBDaemon_tcp_server.c	2007-11-06 14:21:56 UTC (rev 659)
@@ -53,7 +53,7 @@
 /**
  * Update/check Tux status.
  *
- * @return 1 if tux is present, 0 otherwise
+ * /return 1 if tux is present, 0 otherwise
  */
 static int update_tux_status(void)
 {
@@ -119,9 +119,9 @@
 /**
  * Add a TCP client.
  *
- * @param[in] sock  Client's socket
+ * /param[in] sock  Client's socket
  *
- * @return client id if successful, -1 otherwise
+ * /return client id if successful, -1 otherwise
  */
 static int tcp_add_client(int sock)
 {
@@ -144,7 +144,7 @@
  * The client's entry in the clients array is left empty (-1), so this
  * array may contain holes.
  *
- * @param[in] id_client  Id of client to remove
+ * /param[in] id_client  Id of client to remove
  */
 void tcp_remove_client(int id_client)
 {

Modified: daemon/trunk/libs/USBDaemon_usb.c
===================================================================
--- daemon/trunk/libs/USBDaemon_usb.c	2007-11-06 13:59:47 UTC (rev 658)
+++ daemon/trunk/libs/USBDaemon_usb.c	2007-11-06 14:21:56 UTC (rev 659)
@@ -39,7 +39,7 @@
  * Searches all USB buses and returns the first device matching Tux
  * vendor and product id.
  *
- * @return Device found or NULL if none
+ * /return Device found or NULL if none
  */
 struct usb_device *usb_find_TuxDroid(void)
 {
@@ -62,9 +62,9 @@
 /**
  * Open the specified Tux device.
  *
- * @param tux_dev  Tux device (as returned by usb_find_TuxDroid())
+ * /param tux_dev  Tux device (as returned by usb_find_TuxDroid())
  *
- * @return Handle on the device if successful, NULL otherwise
+ * /return Handle on the device if successful, NULL otherwise
  */
 static struct usb_dev_handle *usb_open_TuxDroid(struct usb_device *tux_dev)
 {
@@ -122,7 +122,7 @@
 /**
  * Capture a Tux droid.
  *
- * @return 1 if successful, 0 otherwise
+ * /return 1 if successful, 0 otherwise
  */
 int usb_capture_TuxDroid(void)
 {
@@ -184,10 +184,10 @@
 /**
  * Write data on Tux droid's USB device.
  *
- * @param[in] buf   Buffer to write
- * @param[in] size  Size of buffer
+ * /param[in] buf   Buffer to write
+ * /param[in] size  Size of buffer
  *
- * @return number of bytes written if successful, < 0 otherwise
+ * /return number of bytes written if successful, < 0 otherwise
  */
 int usb_write_TuxDroid(const void *buf, size_t size)
 {
@@ -198,10 +198,10 @@
 /**
  * Read data from Tux droid's USB device.
  *
- * @param[out] buf   Buffer to store data in
- * @param[in]  size  Size of buffer
+ * /param[out] buf   Buffer to store data in
+ * /param[in]  size  Size of buffer
  *
- * @return number of bytes read if successful, < 0 otherwise
+ * /return number of bytes read if successful, < 0 otherwise
  */
 int usb_read_TuxDroid(void *buf, size_t size)
 {
@@ -262,9 +262,9 @@
  * Send data to Tux droid over usb.
  * FIXME: the whole cmd_status_flag thing is clunky.
  *
- * @param[in] data  Data to send
+ * /param[in] data  Data to send
  *
- * @return Acknowledgement (ACK_xxx), may be success or error
+ * /return Acknowledgement (ACK_xxx), may be success or error
  */
 unsigned char usb_send_TuxDroid(unsigned char data[TUX_SEND_LENGTH])
 {