diff options
| author | Stefan Rado <px4@sradonia.net> | 2014-02-14 01:48:00 +0100 |
|---|---|---|
| committer | Stefan Rado <px4@sradonia.net> | 2014-02-14 01:48:00 +0100 |
| commit | 7441efde4745c0dddc08a36a0bbf83307f82948a (patch) | |
| tree | bf3539fdd100914362cea5822d042a28dbca8bc7 /src/lib | |
| parent | ccfe476326d8b01e33a3a7ea115054a31fa7a2b9 (diff) | |
| download | px4-firmware-7441efde4745c0dddc08a36a0bbf83307f82948a.tar.gz px4-firmware-7441efde4745c0dddc08a36a0bbf83307f82948a.tar.bz2 px4-firmware-7441efde4745c0dddc08a36a0bbf83307f82948a.zip | |
Add a lot of MAVLink parameter documentation.
Diffstat (limited to 'src/lib')
| -rw-r--r-- | src/lib/launchdetection/launchdetection_params.c | 48 |
1 files changed, 33 insertions, 15 deletions
diff --git a/src/lib/launchdetection/launchdetection_params.c b/src/lib/launchdetection/launchdetection_params.c index 63a8981aa..45d7957f1 100644 --- a/src/lib/launchdetection/launchdetection_params.c +++ b/src/lib/launchdetection/launchdetection_params.c @@ -45,28 +45,46 @@ #include <systemlib/param/param.h> /* - * Launch detection parameters, accessible via MAVLink + * Catapult launch detection parameters, accessible via MAVLink * */ -/* Catapult Launch detection */ - -// @DisplayName Switch to enable launchdetection -// @Description if set to 1 launchdetection is enabled -// @Range 0 or 1 +/** + * Enable launch detection. + * + * @min 0 + * @max 1 + * @group Launch detection + */ PARAM_DEFINE_INT32(LAUN_ALL_ON, 0); -// @DisplayName Catapult Accelerometer Threshold -// @Description LAUN_CAT_A * LAUN_CAT_T serves as threshold to trigger launch detection -// @Range > 0 +/** + * Catapult accelerometer theshold. + * + * LAUN_CAT_A * LAUN_CAT_T serves as threshold to trigger launch detection. + * + * @min 0 + * @group Launch detection + */ PARAM_DEFINE_FLOAT(LAUN_CAT_A, 30.0f); -// @DisplayName Catapult Time Threshold -// @Description LAUN_CAT_A * LAUN_CAT_T serves as threshold to trigger launch detection -// @Range > 0, in seconds +/** + * Catapult time theshold. + * + * LAUN_CAT_A * LAUN_CAT_T serves as threshold to trigger launch detection. + * + * @min 0 + * @group Launch detection + */ PARAM_DEFINE_FLOAT(LAUN_CAT_T, 0.05f); -// @DisplayName Throttle setting while detecting the launch -// @Description The throttle is set to this value while the system is waiting for the takeoff -// @Range 0 to 1 +/** + * Throttle setting while detecting launch. + * + * The throttle is set to this value while the system is waiting for the take-off. + * + * @min 0 + * @max 1 + * @group Launch detection + */ PARAM_DEFINE_FLOAT(LAUN_THR_PRE, 0.0f); |