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
@@ -42,6 +42,7 @@
/**
* Enable/disable usage of fixed-wing actuators in hover to generate forward force (instead of pitching down).
*
* This technique can be used to avoid the plane having to pitch down in order to move forward.
* This prevents large, negative lift values being created when facing strong winds.
* Fixed-wing forward actuators refers to puller/pusher (standard VTOL), or forward-tilt (tiltrotor VTOL).
@@ -62,7 +63,8 @@ PARAM_DEFINE_INT32(VT_FWD_THRUST_EN, 0);
/**
* Maximum allowed angle the vehicle is allowed to pitch down to generate forward force
* when fixed-wing forward actuation is active (seeVT_FW_TRHUST_EN).
*
* When fixed-wing forward actuation is active (see VT_FW_TRHUST_EN).
* If demanded down pitch exceeds this limmit, the fixed-wing forward actuators are used instead.
*
* @min 0.0
@@ -98,6 +100,7 @@ PARAM_DEFINE_FLOAT(VT_B_TRANS_RAMP, 3.0f);
/**
* Output on airbrakes channel during back transition
*
* Used for airbrakes or with ESCs that have reverse thrust enabled on a seperate channel
* Airbrakes need to be enables for your selected model/mixer
*
@@ -112,6 +115,7 @@ PARAM_DEFINE_FLOAT(VT_B_REV_OUT, 0.0f);
/**
* Delay in seconds before applying back transition throttle
*
* Set this to a value greater than 0 to give the motor time to spin down.
*
* unit s
@@ -124,6 +128,8 @@ PARAM_DEFINE_FLOAT(VT_B_REV_OUT, 0.0f);
PARAM_DEFINE_FLOAT(VT_B_REV_DEL, 0.0f);
/**
* Pusher throttle ramp up window
*
* Defines the time window during which the pusher throttle will be ramped up linearly to VT_F_TRANS_THR during a transition
* to fixed wing mode. Zero or negative values will produce an instant throttle rise to VT_F_TRANS_THR.
*
@@ -116,7 +116,9 @@ PARAM_DEFINE_FLOAT(VT_B_TRANS_DUR, 4.0f);
/**
* Target throttle value for the transition to fixed wing flight.
*
* standard vtol: pusher
*
* tailsitter, tiltrotor: main throttle
*
* @min 0.0
@@ -129,7 +131,9 @@ PARAM_DEFINE_FLOAT(VT_F_TRANS_THR, 1.0f);
/**
* Target throttle value for the transition to hover flight.
*
* standard vtol: pusher
*
* tailsitter, tiltrotor: main throttle
*
* Note for standard vtol: