params: ensure short description is only a single line

So a UI can display it properly
This commit is contained in:
Beat Küng
2021-03-23 12:55:11 -04:00
committed by Daniel Agar
parent 2ab276f5ca
commit 629f7ba15b
25 changed files with 120 additions and 30 deletions
+1
View File
@@ -87,6 +87,7 @@ PARAM_DEFINE_FLOAT(SENS_FLOW_MAXHGT, 3.0f);
/**
* Magnitude of maximum angular flow rate reliably measurable by the optical flow sensor.
*
* Optical flow data will not fused by the estimators if the magnitude of the flow rate exceeds this value and
* control loops will be instructed to limit ground speed such that the flow rate produced by movement over ground
* is less than 50% of this value.
+9 -3
View File
@@ -195,9 +195,11 @@ PARAM_DEFINE_FLOAT(CAL_MAG0_YODIAG, 0.0f);
PARAM_DEFINE_FLOAT(CAL_MAG0_ZODIAG, 0.0f);
/**
* X Axis throttle compensation for Mag 0
*
* Coefficient describing linear relationship between
* X component of magnetometer in body frame axis
* and either current or throttle depending on value of CAL_MAG_COMP_TYP
* and either current or throttle depending on value of CAL_MAG_COMP_TYP.
* Unit for throttle-based compensation is [G] and
* for current-based compensation [G/kA]
*
@@ -207,9 +209,11 @@ PARAM_DEFINE_FLOAT(CAL_MAG0_ZODIAG, 0.0f);
PARAM_DEFINE_FLOAT(CAL_MAG0_XCOMP, 0.0f);
/**
* Y Axis throttle compensation for Mag 0
*
* Coefficient describing linear relationship between
* Y component of magnetometer in body frame axis
* and either current or throttle depending on value of CAL_MAG_COMP_TYP
* and either current or throttle depending on value of CAL_MAG_COMP_TYP.
* Unit for throttle-based compensation is [G] and
* for current-based compensation [G/kA]
*
@@ -219,9 +223,11 @@ PARAM_DEFINE_FLOAT(CAL_MAG0_XCOMP, 0.0f);
PARAM_DEFINE_FLOAT(CAL_MAG0_YCOMP, 0.0f);
/**
* Z Axis throttle compensation for Mag 0
*
* Coefficient describing linear relationship between
* Z component of magnetometer in body frame axis
* and either current or throttle depending on value of CAL_MAG_COMP_TYP
* and either current or throttle depending on value of CAL_MAG_COMP_TYP.
* Unit for throttle-based compensation is [G] and
* for current-based compensation [G/kA]
*
+9 -3
View File
@@ -195,9 +195,11 @@ PARAM_DEFINE_FLOAT(CAL_MAG1_YODIAG, 0.0f);
PARAM_DEFINE_FLOAT(CAL_MAG1_ZODIAG, 0.0f);
/**
* X Axis throttle compensation for Mag 1
*
* Coefficient describing linear relationship between
* X component of magnetometer in body frame axis
* and either current or throttle depending on value of CAL_MAG_COMP_TYP
* and either current or throttle depending on value of CAL_MAG_COMP_TYP.
* Unit for throttle-based compensation is [G] and
* for current-based compensation [G/kA]
*
@@ -207,9 +209,11 @@ PARAM_DEFINE_FLOAT(CAL_MAG1_ZODIAG, 0.0f);
PARAM_DEFINE_FLOAT(CAL_MAG1_XCOMP, 0.0f);
/**
* Y Axis throttle compensation for Mag 1
*
* Coefficient describing linear relationship between
* Y component of magnetometer in body frame axis
* and either current or throttle depending on value of CAL_MAG_COMP_TYP
* and either current or throttle depending on value of CAL_MAG_COMP_TYP.
* Unit for throttle-based compensation is [G] and
* for current-based compensation [G/kA]
*
@@ -219,9 +223,11 @@ PARAM_DEFINE_FLOAT(CAL_MAG1_XCOMP, 0.0f);
PARAM_DEFINE_FLOAT(CAL_MAG1_YCOMP, 0.0f);
/**
* Z Axis throttle compensation for Mag 1
*
* Coefficient describing linear relationship between
* Z component of magnetometer in body frame axis
* and either current or throttle depending on value of CAL_MAG_COMP_TYP
* and either current or throttle depending on value of CAL_MAG_COMP_TYP.
* Unit for throttle-based compensation is [G] and
* for current-based compensation [G/kA]
*
+9 -3
View File
@@ -195,9 +195,11 @@ PARAM_DEFINE_FLOAT(CAL_MAG2_YODIAG, 0.0f);
PARAM_DEFINE_FLOAT(CAL_MAG2_ZODIAG, 0.0f);
/**
* X Axis throttle compensation for Mag 2
*
* Coefficient describing linear relationship between
* X component of magnetometer in body frame axis
* and either current or throttle depending on value of CAL_MAG_COMP_TYP
* and either current or throttle depending on value of CAL_MAG_COMP_TYP.
* Unit for throttle-based compensation is [G] and
* for current-based compensation [G/kA]
*
@@ -207,9 +209,11 @@ PARAM_DEFINE_FLOAT(CAL_MAG2_ZODIAG, 0.0f);
PARAM_DEFINE_FLOAT(CAL_MAG2_XCOMP, 0.0f);
/**
* Y Axis throttle compensation for Mag 2
*
* Coefficient describing linear relationship between
* Y component of magnetometer in body frame axis
* and either current or throttle depending on value of CAL_MAG_COMP_TYP
* and either current or throttle depending on value of CAL_MAG_COMP_TYP.
* Unit for throttle-based compensation is [G] and
* for current-based compensation [G/kA]
*
@@ -219,9 +223,11 @@ PARAM_DEFINE_FLOAT(CAL_MAG2_XCOMP, 0.0f);
PARAM_DEFINE_FLOAT(CAL_MAG2_YCOMP, 0.0f);
/**
* Z Axis throttle compensation for Mag 2
*
* Coefficient describing linear relationship between
* Z component of magnetometer in body frame axis
* and either current or throttle depending on value of CAL_MAG_COMP_TYP
* and either current or throttle depending on value of CAL_MAG_COMP_TYP.
* Unit for throttle-based compensation is [G] and
* for current-based compensation [G/kA]
*
+9 -3
View File
@@ -195,9 +195,11 @@ PARAM_DEFINE_FLOAT(CAL_MAG3_YODIAG, 0.0f);
PARAM_DEFINE_FLOAT(CAL_MAG3_ZODIAG, 0.0f);
/**
* X Axis throttle compensation for Mag 3
*
* Coefficient describing linear relationship between
* X component of magnetometer in body frame axis
* and either current or throttle depending on value of CAL_MAG_COMP_TYP
* and either current or throttle depending on value of CAL_MAG_COMP_TYP.
* Unit for throttle-based compensation is [G] and
* for current-based compensation [G/kA]
*
@@ -207,9 +209,11 @@ PARAM_DEFINE_FLOAT(CAL_MAG3_ZODIAG, 0.0f);
PARAM_DEFINE_FLOAT(CAL_MAG3_XCOMP, 0.0f);
/**
* Y Axis throttle compensation for Mag 3
*
* Coefficient describing linear relationship between
* Y component of magnetometer in body frame axis
* and either current or throttle depending on value of CAL_MAG_COMP_TYP
* and either current or throttle depending on value of CAL_MAG_COMP_TYP.
* Unit for throttle-based compensation is [G] and
* for current-based compensation [G/kA]
*
@@ -219,9 +223,11 @@ PARAM_DEFINE_FLOAT(CAL_MAG3_XCOMP, 0.0f);
PARAM_DEFINE_FLOAT(CAL_MAG3_YCOMP, 0.0f);
/**
* Z Axis throttle compensation for Mag 3
*
* Coefficient describing linear relationship between
* Z component of magnetometer in body frame axis
* and either current or throttle depending on value of CAL_MAG_COMP_TYP
* and either current or throttle depending on value of CAL_MAG_COMP_TYP.
* Unit for throttle-based compensation is [G] and
* for current-based compensation [G/kA]
*