Author: remi
Date: 2008-12-01 10:38:36 +0100 (Mon, 01 Dec 2008)
New Revision: 2949
Modified:
software_suite_v2/tuxware/tuxdriver/trunk/src/tux_descriptor.c
software_suite_v2/tuxware/tuxdriver/trunk/src/tux_descriptor.h
Log:
* added comments and doxygen.
Modified: software_suite_v2/tuxware/tuxdriver/trunk/src/tux_descriptor.c
===================================================================
--- software_suite_v2/tuxware/tuxdriver/trunk/src/tux_descriptor.c
2008-12-01 09:23:31 UTC (rev 2948)
+++ software_suite_v2/tuxware/tuxdriver/trunk/src/tux_descriptor.c
2008-12-01 09:38:36 UTC (rev 2949)
@@ -18,6 +18,13 @@
* 02111-1307, USA.
*/
+/**
+ * \file tux_descriptor.c
+ * \brief Descriptor functions.
+ * \author [EMAIL PROTECTED]
+ * \ingroup descriptor
+ */
+
#include <errno.h>
#include <stdio.h>
#include <string.h>
@@ -27,7 +34,7 @@
#include "tux_sw_status.h"
/**
- *
+ * \brief Initialize the descriptor.
*/
LIBLOCAL void
tux_descriptor_init(void)
@@ -38,7 +45,7 @@
}
/**
- *
+ * \brief Command to start the descriptor retrieving (asynchronous)
*/
LIBLOCAL void
tux_descriptor_get(void)
@@ -50,7 +57,8 @@
}
/**
- *
+ * \brief Dump the descriptor in a file.
+ * \deprecated
*/
LIBLOCAL void
tux_descriptor_dump(void)
@@ -86,7 +94,9 @@
}
/**
- *
+ * \brief Check if the connected Tuxdroid is the same as the previouslty
+ * connected. Reset the RF connection if different.
+ * \deprecated
*/
static void
check_tux_has_changed(void)
@@ -112,7 +122,7 @@
}
/**
- *
+ * \brief Command to call when the descriptor was completly retrieved.
*/
LIBLOCAL void
tux_descriptor_update(void)
Modified: software_suite_v2/tuxware/tuxdriver/trunk/src/tux_descriptor.h
===================================================================
--- software_suite_v2/tuxware/tuxdriver/trunk/src/tux_descriptor.h
2008-12-01 09:23:31 UTC (rev 2948)
+++ software_suite_v2/tuxware/tuxdriver/trunk/src/tux_descriptor.h
2008-12-01 09:38:36 UTC (rev 2949)
@@ -18,6 +18,13 @@
* 02111-1307, USA.
*/
+/**
+ * \file tux_descriptor.h
+ * \brief Descriptor header.
+ * \author [EMAIL PROTECTED]
+ * \ingroup descriptor
+ */
+
#ifndef _TUX_DESCRIPTOR_H_
#define _TUX_DESCRIPTOR_H_
@@ -25,27 +32,32 @@
#include "tux_sound_flash.h"
#include "tux_id.h"
+/** \brief Output file path of the descriptor */
#define DESCRIPTOR_FILE_PATH "./descriptor.txt"
+/**
+ * \brief Tuxdroid descriptor.
+ * The descriptor contains some informations about the Tuxdroid hardware.
+ */
typedef struct {
struct firmwares_t {
- firmware_descriptor_t *package;
- firmware_descriptor_t *tuxcore;
- firmware_descriptor_t *tuxaudio;
- firmware_descriptor_t *tuxrf;
- firmware_descriptor_t *fuxrf;
- firmware_descriptor_t *fuxusb;
- } firmwares;
+ firmware_descriptor_t *package; /**< Package version */
+ firmware_descriptor_t *tuxcore; /**< Tuxcore version */
+ firmware_descriptor_t *tuxaudio; /**< Tuxaudio version */
+ firmware_descriptor_t *tuxrf; /**< Tuxrf version */
+ firmware_descriptor_t *fuxrf; /**< Fuxrf version */
+ firmware_descriptor_t *fuxusb; /**< Fuxusb version */
+ } firmwares; /**< About firmwares */
struct driver_version_t {
- unsigned int version_major;
- unsigned int version_minor;
- unsigned int version_update;
- unsigned int version_build;
- char version_state[100];
- char version_string[100];
- } driver;
- sound_flash_descriptor_t *sound_flash;
- id_descriptor_t *id;
+ unsigned int version_major; /**< Major version number */
+ unsigned int version_minor; /**< Minor version number */
+ unsigned int version_update; /**< Update version number */
+ unsigned int version_build; /**< Build version number */
+ char version_state[100]; /**< Version state */
+ char version_string[100]; /**< Complete version string */
+ } driver; /**< About libtuxdriver */
+ sound_flash_descriptor_t *sound_flash; /**< About the sound flash */
+ id_descriptor_t *id; /**< About Id connection */
} tux_descriptor_t;
extern void tux_descriptor_init(void);
-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________
Tux-droid-svn mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/tux-droid-svn
