diff options
author | Darryl Taylor <darryl.c.taylor@gmail.com> | 2014-06-22 16:43:05 +0800 |
---|---|---|
committer | Darryl Taylor <darryl.c.taylor@gmail.com> | 2014-06-22 16:43:05 +0800 |
commit | ebd68f4ffa2b6f3b6fdb1a19ef22b1aab54b4251 (patch) | |
tree | 8065be1dd6857433a33875a888a61c3ab6fcc5a7 | |
parent | 45d5e2600911682a9117b26603e3213c6b918fa4 (diff) | |
download | px4-firmware-ebd68f4ffa2b6f3b6fdb1a19ef22b1aab54b4251.tar.gz px4-firmware-ebd68f4ffa2b6f3b6fdb1a19ef22b1aab54b4251.tar.bz2 px4-firmware-ebd68f4ffa2b6f3b6fdb1a19ef22b1aab54b4251.zip |
Clarified parameter comments and added @group attributed for auto-generation.
-rw-r--r-- | src/modules/sensors/sensor_params.c | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/src/modules/sensors/sensor_params.c b/src/modules/sensors/sensor_params.c index 850e5f4e2..c8a3ec8f0 100644 --- a/src/modules/sensors/sensor_params.c +++ b/src/modules/sensors/sensor_params.c @@ -243,26 +243,32 @@ PARAM_DEFINE_INT32(SENS_DPRES_ANA, 0); PARAM_DEFINE_INT32(SENS_BOARD_ROT, 0); /** - * Board rotation pitch offset + * Board rotation Y (Pitch) offset * - * This parameter defines a pitch offset from the board rotation. It allows the user + * This parameter defines a rotational offset in degrees around the Y (Pitch) axis. It allows the user * to fine tune the board offset in the event of misalignment. + * + * @group Sensor Calibration */ PARAM_DEFINE_FLOAT(SENS_BOARD_Y_OFF, 0.0f); /** - * Board rotation roll offset + * Board rotation X (Roll) offset * - * This parameter defines a roll offset from the board rotation. It allows the user + * This parameter defines a rotational offset in degrees around the X (Roll) axis It allows the user * to fine tune the board offset in the event of misalignment. + * + * @group Sensor Calibration */ PARAM_DEFINE_FLOAT(SENS_BOARD_X_OFF, 0.0f); /** - * Board rotation YAW offset + * Board rotation Z (YAW) offset * - * This parameter defines a yaw offset from the board rotation. It allows the user + * This parameter defines a rotational offset in degrees around the Z (Yaw) axis. It allows the user * to fine tune the board offset in the event of misalignment. + * + * @group Sensor Calibration */ PARAM_DEFINE_FLOAT(SENS_BOARD_Z_OFF, 0.0f); |