aboutsummaryrefslogtreecommitdiff
path: root/src/modules/navigator/geofence_params.c
diff options
context:
space:
mode:
authorStefan Rado <px4@sradonia.net>2014-02-14 01:48:00 +0100
committerStefan Rado <px4@sradonia.net>2014-02-14 01:48:00 +0100
commit7441efde4745c0dddc08a36a0bbf83307f82948a (patch)
treebf3539fdd100914362cea5822d042a28dbca8bc7 /src/modules/navigator/geofence_params.c
parentccfe476326d8b01e33a3a7ea115054a31fa7a2b9 (diff)
downloadpx4-firmware-7441efde4745c0dddc08a36a0bbf83307f82948a.tar.gz
px4-firmware-7441efde4745c0dddc08a36a0bbf83307f82948a.tar.bz2
px4-firmware-7441efde4745c0dddc08a36a0bbf83307f82948a.zip
Add a lot of MAVLink parameter documentation.
Diffstat (limited to 'src/modules/navigator/geofence_params.c')
-rw-r--r--src/modules/navigator/geofence_params.c16
1 files changed, 11 insertions, 5 deletions
diff --git a/src/modules/navigator/geofence_params.c b/src/modules/navigator/geofence_params.c
index 20dd1fe2f..5831a0ca9 100644
--- a/src/modules/navigator/geofence_params.c
+++ b/src/modules/navigator/geofence_params.c
@@ -45,11 +45,17 @@
#include <systemlib/param/param.h>
/*
- * geofence parameters, accessible via MAVLink
- *
+ * Geofence parameters, accessible via MAVLink
*/
-// @DisplayName Switch to enable geofence
-// @Description if set to 1 geofence is enabled, defaults to 1 because geofence is only enabled when the geofence.txt file is present
-// @Range 0 or 1
+/**
+ * Enable geofence.
+ *
+ * Set to 1 to enable geofence.
+ * Defaults to 1 because geofence is only enabled when the geofence.txt file is present.
+ *
+ * @min 0
+ * @max 1
+ * @group Geofence
+ */
PARAM_DEFINE_INT32(GF_ON, 1);