[dox] some doxygen updates

This commit is contained in:
Felix Ruess
2013-11-20 13:56:13 +01:00
parent a6b8f054ce
commit 4084168753
4 changed files with 36 additions and 9 deletions
+10 -2
View File
@@ -3,8 +3,16 @@
<module name="rotorcraft_cam" dir="cam_control">
<doc>
<description>
Camera control for rotorcraft.
The camera is controled by the heading of the vehicle for pan and can be controlled by a servo for tilt if defined.
Camera control for rotorcraft.
The camera is controled by the heading of the vehicle for pan and can be controlled by a servo for tilt if defined.
Four modes:
- NONE: no control
- MANUAL: the servo position is set with PWM
- HEADING: the servo position and the heading of the rotorcraft are set with angles
- WP: the camera is tracking a waypoint (Default: CAM)
The CAM_SWITCH can be used to power the camera in normal modes and disable it when in NONE mode.
</description>
<section name="CAM" prefix="ROTORCRAFT_CAM_">
<define name="DEFAULT_MODE" value="MODE_NONE|MODE_MANUAL|MODE_HEADING|MODE_WP" description="Select default mode (default: MODE_NONE)"/>
@@ -20,6 +20,23 @@
* Boston, MA 02111-1307, USA.
*/
/**
* @file modules/cam_control/rotorcraft_cam.c
* Camera control module for rotorcraft.
*
* The camera is controled by the heading of the vehicle for pan
* and can be controlled by a servo for tilt if defined.
*
* Four modes:
* - NONE: no control
* - MANUAL: the servo position is set with PWM
* - HEADING: the servo position and the heading of the rotorcraft are set with angles
* - WP: the camera is tracking a waypoint (Default: CAM)
*
* The CAM_SWITCH can be used to power the camera in normal modes
* and disable it when in NONE mode
*/
#include "modules/cam_control/rotorcraft_cam.h"
#include "subsystems/actuators.h"
@@ -20,7 +20,9 @@
* Boston, MA 02111-1307, USA.
*/
/** Camera control module for rotorcraft.
/**
* @file modules/cam_control/rotorcraft_cam.h
* Camera control module for rotorcraft.
*
* The camera is controled by the heading of the vehicle for pan
* and can be controlled by a servo for tilt if defined.
+6 -6
View File
@@ -29,21 +29,21 @@
*
* In order to use it a subsystem/module:
* - include this header:
*
* @code
* #include "susystems/datalink/telemetry.h"
*
* @endcode
* - write a callback function:
*
* @code
* void your_callback(void) {
* // your code to send a telemetry message goes here
* }
*
* @endcode
* - register your callback function (if the message name doesn't match
* one of the names in your telemetry xml file or is already registered,
* the function return FALSE)
*
* @code
* register_periodic_telemetry(&your_telemetry_struct, "YOUR_MESSAGE_NAME", your_callback);
*
* @endcode
* In most cases, the default telemetry structure should be used
* (replace &your_telemetry_struct by DefaultPeriodic in the register function).
*/