Author: remi
Date: 2008-12-01 11:45:25 +0100 (Mon, 01 Dec 2008)
New Revision: 2953
Modified:
software_suite_v2/tuxware/tuxdriver/trunk/src/tux_eyes.c
software_suite_v2/tuxware/tuxdriver/trunk/src/tux_eyes.h
software_suite_v2/tuxware/tuxdriver/trunk/src/tux_flippers.c
software_suite_v2/tuxware/tuxdriver/trunk/src/tux_flippers.h
software_suite_v2/tuxware/tuxdriver/trunk/src/tux_mouth.c
software_suite_v2/tuxware/tuxdriver/trunk/src/tux_mouth.h
software_suite_v2/tuxware/tuxdriver/trunk/src/tux_spinning.c
software_suite_v2/tuxware/tuxdriver/trunk/src/tux_spinning.h
Log:
* added comments and doxygen.
Modified: software_suite_v2/tuxware/tuxdriver/trunk/src/tux_eyes.c
===================================================================
--- software_suite_v2/tuxware/tuxdriver/trunk/src/tux_eyes.c 2008-12-01
10:24:00 UTC (rev 2952)
+++ software_suite_v2/tuxware/tuxdriver/trunk/src/tux_eyes.c 2008-12-01
10:45:25 UTC (rev 2953)
@@ -18,6 +18,13 @@
* 02111-1307, USA.
*/
+/**
+ * \file tux_eyes.c
+ * \brief Eyes functions.
+ * \author [EMAIL PROTECTED]
+ * \ingroup eyes
+ */
+
#include <string.h>
#include "tux_cmd_parser.h"
@@ -30,10 +37,11 @@
#include "tux_types.h"
#include "tux_usb.h"
+/** Counter of eyes movements */
static unsigned char mvmt_counter = 0;
/**
- * Update the status of the position of the eyes.
+ * \brief Update the status of the position of the eyes.
*/
LIBLOCAL void
tux_eyes_update_position(void)
@@ -60,7 +68,7 @@
}
/**
- * Update the status of the motor state of the eyes.
+ * \brief Update the status of the motor state of the eyes.
*/
LIBLOCAL void
tux_eyes_update_motor(void)
@@ -72,7 +80,7 @@
}
/**
- * Update the status of the eyes movements remaining.
+ * \brief Update the status of the eyes movements remaining.
*/
LIBLOCAL void
tux_eyes_update_movements_remaining(void)
@@ -86,7 +94,10 @@
}
/**
- *
+ * \brief Execute an eyes on command.
+ * \param counter Number of eyes movements.
+ * \param final_state Desired final state of the eyes.
+ * \return The command success result.
*/
LIBLOCAL bool
tux_eyes_cmd_on(unsigned char counter, unsigned char final_state)
@@ -95,7 +106,10 @@
}
/**
- *
+ * \brief Execute an eyes on command.
+ * \param timeout Duration of the movement.
+ * \param final_state Desired final state of the eyes.
+ * \return The command success result.
*/
LIBLOCAL bool
tux_eyes_cmd_on_during(float timeout, unsigned char final_state)
@@ -141,7 +155,8 @@
}
/**
- *
+ * \brief Open the eyes.
+ * \return The command success result.
*/
LIBLOCAL bool
tux_eyes_cmd_open(void)
@@ -150,7 +165,8 @@
}
/**
- *
+ * \brief Close the eyes.
+ * \return The command success result.
*/
LIBLOCAL bool
tux_eyes_cmd_close(void)
@@ -159,7 +175,8 @@
}
/**
- *
+ * \brief Stop the eyes movement.
+ * \return The command success result.
*/
LIBLOCAL bool
tux_eyes_cmd_off(void)
Modified: software_suite_v2/tuxware/tuxdriver/trunk/src/tux_eyes.h
===================================================================
--- software_suite_v2/tuxware/tuxdriver/trunk/src/tux_eyes.h 2008-12-01
10:24:00 UTC (rev 2952)
+++ software_suite_v2/tuxware/tuxdriver/trunk/src/tux_eyes.h 2008-12-01
10:45:25 UTC (rev 2953)
@@ -18,11 +18,21 @@
* 02111-1307, USA.
*/
+/**
+ * \file tux_eyes.h
+ * \brief Eyes header.
+ * \author [EMAIL PROTECTED]
+ * \ingroup eyes
+ */
+
#ifndef _TUX_EYES_H_
#define _TUX_EYES_H_
+/** \brief Eyes position not defined */
#define TUX_EYES_POSITION_NDEF 0
+/** \brief Eyes position open */
#define TUX_EYES_POSITION_OPEN 1
+/** \brief Eyes position close */
#define TUX_EYES_POSITION_CLOSE 2
extern void tux_eyes_update_position(void);
Modified: software_suite_v2/tuxware/tuxdriver/trunk/src/tux_flippers.c
===================================================================
--- software_suite_v2/tuxware/tuxdriver/trunk/src/tux_flippers.c
2008-12-01 10:24:00 UTC (rev 2952)
+++ software_suite_v2/tuxware/tuxdriver/trunk/src/tux_flippers.c
2008-12-01 10:45:25 UTC (rev 2953)
@@ -18,6 +18,13 @@
* 02111-1307, USA.
*/
+/**
+ * \file tux_flippers.c
+ * \brief Flippers functions.
+ * \author [EMAIL PROTECTED]
+ * \ingroup flippers
+ */
+
#include <string.h>
#include "tux_cmd_parser.h"
@@ -29,10 +36,11 @@
#include "tux_usb.h"
#include "tux_flippers.h"
+/** Counter of flippers movements */
static unsigned char mvmt_counter = 0;
/**
- *
+ * \brief Update the status of the position of the flippers.
*/
LIBLOCAL void
tux_flippers_update_position(void)
@@ -52,7 +60,7 @@
}
/**
- * Update the status of the motor state of the flippers.
+ * \brief Update the status of the motor state of the flippers.
*/
LIBLOCAL void
tux_flippers_update_motor(void)
@@ -64,7 +72,7 @@
}
/**
- *
+ * \brief Update the status of the flippers movements remaining.
*/
LIBLOCAL void
tux_flippers_update_movements_remaining(void)
@@ -78,7 +86,9 @@
}
/**
- *
+ * \brief Set the speed of the flippers movements.
+ * \param speed Movement speed.
+ * \return The command success result.
*/
LIBLOCAL bool
tux_flippers_cmd_speed(unsigned char speed)
@@ -88,7 +98,10 @@
}
/**
- *
+ * \brief Execute a flippers on command.
+ * \param counter Number of flippers movements.
+ * \param final_state Desired final state of the flippers.
+ * \return The command success result.
*/
LIBLOCAL bool
tux_flippers_cmd_on(unsigned char counter, unsigned char final_state)
@@ -97,7 +110,10 @@
}
/**
- *
+ * \brief Execute a flippers on command.
+ * \param timeout Duration of the movement.
+ * \param final_state Desired final state of the flippers.
+ * \return The command success result.
*/
LIBLOCAL bool
tux_flippers_cmd_on_during(float timeout, unsigned char final_state)
@@ -143,7 +159,8 @@
}
/**
- *
+ * \brief Raise the flippers.
+ * \return The command success result.
*/
LIBLOCAL bool
tux_flippers_cmd_up(void)
@@ -152,7 +169,8 @@
}
/**
- *
+ * \brief Lower the flippers.
+ * \return The command success result.
*/
LIBLOCAL bool
tux_flippers_cmd_down(void)
@@ -161,7 +179,8 @@
}
/**
- *
+ * \brief Stop the flippers movement.
+ * \return The command success result.
*/
LIBLOCAL bool
tux_flippers_cmd_off(void)
Modified: software_suite_v2/tuxware/tuxdriver/trunk/src/tux_flippers.h
===================================================================
--- software_suite_v2/tuxware/tuxdriver/trunk/src/tux_flippers.h
2008-12-01 10:24:00 UTC (rev 2952)
+++ software_suite_v2/tuxware/tuxdriver/trunk/src/tux_flippers.h
2008-12-01 10:45:25 UTC (rev 2953)
@@ -18,12 +18,21 @@
* 02111-1307, USA.
*/
+/**
+ * \file tux_flippers.h
+ * \brief Flippers header.
+ * \author [EMAIL PROTECTED]
+ * \ingroup flippers
+ */
+
#ifndef _TUX_FLIPPERS_H_
#define _TUX_FLIPPERS_H_
#include <stdbool.h>
+/** \brief Flippers position down */
#define TUX_FLIPPERS_POSITION_DOWN 0
+/** \brief Flippers position up */
#define TUX_FLIPPERS_POSITION_UP 1
extern void tux_flippers_update_position(void);
Modified: software_suite_v2/tuxware/tuxdriver/trunk/src/tux_mouth.c
===================================================================
--- software_suite_v2/tuxware/tuxdriver/trunk/src/tux_mouth.c 2008-12-01
10:24:00 UTC (rev 2952)
+++ software_suite_v2/tuxware/tuxdriver/trunk/src/tux_mouth.c 2008-12-01
10:45:25 UTC (rev 2953)
@@ -18,6 +18,13 @@
* 02111-1307, USA.
*/
+/**
+ * \file tux_mouth.c
+ * \brief Mouth functions.
+ * \author [EMAIL PROTECTED]
+ * \ingroup mouth
+ */
+
#include <string.h>
#include "tux_cmd_parser.h"
@@ -30,10 +37,11 @@
#include "tux_types.h"
#include "tux_usb.h"
+/** Counter of mouth movements */
static unsigned char mvmt_counter = 0;
/**
- *
+ * \brief Update the status of the position of the mouth.
*/
LIBLOCAL void
tux_mouth_update_position(void)
@@ -60,7 +68,7 @@
}
/**
- * Update the status of the motor state of the mouth.
+ * \brief Update the status of the motor state of the mouth.
*/
LIBLOCAL void
tux_mouth_update_motor(void)
@@ -72,7 +80,7 @@
}
/**
- *
+ * \brief Update the status of the mouth movements remaining.
*/
LIBLOCAL void
tux_mouth_update_movements_remaining(void)
@@ -86,7 +94,10 @@
}
/**
- *
+ * \brief Execute a mouth on command.
+ * \param counter Number of mouth movements.
+ * \param final_state Desired final state of the mouth.
+ * \return The command success result.
*/
LIBLOCAL bool
tux_mouth_cmd_on(unsigned char counter, unsigned char final_state)
@@ -96,7 +107,10 @@
#include <stdio.h>
/**
- *
+ * \brief Execute a mouth on command.
+ * \param timeout Duration of the movement.
+ * \param final_state Desired final state of the mouth.
+ * \return The command success result.
*/
LIBLOCAL bool
tux_mouth_cmd_on_during(float timeout, unsigned char final_state)
@@ -142,7 +156,8 @@
}
/**
- *
+ * \brief Open the mouth.
+ * \return The command success result.
*/
LIBLOCAL bool
tux_mouth_cmd_open(void)
@@ -151,7 +166,8 @@
}
/**
- *
+ * \brief Close the mouth.
+ * \return The command success result.
*/
LIBLOCAL bool
tux_mouth_cmd_close(void)
@@ -160,7 +176,8 @@
}
/**
- *
+ * \brief Stop the mouth movement.
+ * \return The command success result.
*/
LIBLOCAL bool
tux_mouth_cmd_off(void)
Modified: software_suite_v2/tuxware/tuxdriver/trunk/src/tux_mouth.h
===================================================================
--- software_suite_v2/tuxware/tuxdriver/trunk/src/tux_mouth.h 2008-12-01
10:24:00 UTC (rev 2952)
+++ software_suite_v2/tuxware/tuxdriver/trunk/src/tux_mouth.h 2008-12-01
10:45:25 UTC (rev 2953)
@@ -18,13 +18,23 @@
* 02111-1307, USA.
*/
+/**
+ * \file tux_mouth.h
+ * \brief Mouth header.
+ * \author [EMAIL PROTECTED]
+ * \ingroup mouth
+ */
+
#ifndef _TUX_MOUTH_H_
#define _TUX_MOUTH_H_
#include <stdbool.h>
+/** \brief Mouth position not defined */
#define TUX_MOUTH_POSITION_NDEF 0
+/** \brief Mouth position open */
#define TUX_MOUTH_POSITION_OPEN 1
+/** \brief Mouth position close */
#define TUX_MOUTH_POSITION_CLOSE 2
extern void tux_mouth_update_position(void);
Modified: software_suite_v2/tuxware/tuxdriver/trunk/src/tux_spinning.c
===================================================================
--- software_suite_v2/tuxware/tuxdriver/trunk/src/tux_spinning.c
2008-12-01 10:24:00 UTC (rev 2952)
+++ software_suite_v2/tuxware/tuxdriver/trunk/src/tux_spinning.c
2008-12-01 10:45:25 UTC (rev 2953)
@@ -18,6 +18,13 @@
* 02111-1307, USA.
*/
+/**
+ * \file tux_spinning.c
+ * \brief Spinning functions.
+ * \author [EMAIL PROTECTED]
+ * \ingroup spinning
+ */
+
#include <string.h>
#include "tux_cmd_parser.h"
@@ -29,10 +36,11 @@
#include "tux_types.h"
#include "tux_usb.h"
+/** Counter of spinning movements */
static unsigned char mvmt_counter = 0;
/**
- *
+ * \brief Update the status of the direction of the spinning.
*/
LIBLOCAL void
tux_spinning_update_direction(void)
@@ -63,7 +71,7 @@
}
/**
- * Update the status of the motor state of the left spin.
+ * \brief Update the status of the motor state of the left spin.
*/
LIBLOCAL void
tux_spinning_update_left_motor(void)
@@ -75,7 +83,7 @@
}
/**
- * Update the status of the motor state of the right spin.
+ * \brief Update the status of the motor state of the right spin.
*/
LIBLOCAL void
tux_spinning_update_right_motor(void)
@@ -87,7 +95,7 @@
}
/**
- *
+ * \brief Update the status of the spinning movements remaining.
*/
LIBLOCAL void
tux_spinning_update_movements_remaining(void)
@@ -101,7 +109,9 @@
}
/**
- *
+ * \brief Set the speed of the spinning movements.
+ * \param speed Movement speed.
+ * \return The command success result.
*/
LIBLOCAL bool
tux_spinning_cmd_speed(unsigned char speed)
@@ -110,7 +120,12 @@
true);
}
-
+/**
+ * \brief Execute a spinning on command.
+ * \param movement Direction of the movement
+ * \param counter Number of spinning movements.
+ * \return The command success result.
+ */
static bool
tux_spinning_cmd_on(move_body_part_t movement, unsigned char counter)
{
@@ -119,7 +134,9 @@
}
/**
- *
+ * \brief Execute a spinning on command to the left.
+ * \param counter Number of spinning movements.
+ * \return The command success result.
*/
LIBLOCAL bool
tux_spinning_cmd_left_on(unsigned char counter)
@@ -128,7 +145,9 @@
}
/**
- *
+ * \brief Execute a spinning on command to the right.
+ * \param counter Number of spinning movements.
+ * \return The command success result.
*/
LIBLOCAL bool
tux_spinning_cmd_right_on(unsigned char counter)
@@ -137,7 +156,11 @@
}
/**
- *
+ * \brief Execute a spinning on command.
+ * \param timeout Duration of the movement.
+ * \param command Command for long movement.
+ * \param movement Direction of the movement.
+ * \return The command success result.
*/
static bool
tux_spinning_cmd_on_during(float timeout, unsigned char command,
@@ -170,7 +193,9 @@
}
/**
- *
+ * \brief Execute a spinning on command to the left.
+ * \param timeout Duration of the movement.
+ * \return The command success result.
*/
LIBLOCAL bool
tux_spinning_cmd_left_on_during(float timeout)
@@ -179,7 +204,9 @@
}
/**
- *
+ * \brief Execute a spinning on command to the right.
+ * \param timeout Duration of the movement.
+ * \return The command success result.
*/
LIBLOCAL bool
tux_spinning_cmd_right_on_during(float timeout)
@@ -188,7 +215,8 @@
}
/**
- *
+ * \brief Stop the spinning movement.
+ * \return The command success result.
*/
LIBLOCAL bool
tux_spinning_cmd_off(void)
Modified: software_suite_v2/tuxware/tuxdriver/trunk/src/tux_spinning.h
===================================================================
--- software_suite_v2/tuxware/tuxdriver/trunk/src/tux_spinning.h
2008-12-01 10:24:00 UTC (rev 2952)
+++ software_suite_v2/tuxware/tuxdriver/trunk/src/tux_spinning.h
2008-12-01 10:45:25 UTC (rev 2953)
@@ -18,13 +18,23 @@
* 02111-1307, USA.
*/
+/**
+ * \file tux_spinning.h
+ * \brief Spinning header.
+ * \author [EMAIL PROTECTED]
+ * \ingroup spinning
+ */
+
#ifndef _TUX_SPINNING_H_
#define _TUX_SPINNING_H_
#include <stdbool.h>
+/** \brief Spinning direction none (stopped) */
#define TUX_SPINNING_DIRECTION_NONE 0
+/** \brief Spinning direction left */
#define TUX_SPINNING_DIRECTION_LEFT 1
+/** \brief Spinning direction right */
#define TUX_SPINNING_DIRECTION_RIGHT 2
extern void tux_spinning_update_direction(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
