EKF: Correct documentation and function name for declination accessor

The function name and documentation are misleading given the function is only a getter.
This change makes the usage clearer.
This commit is contained in:
Paul Riseborough
2018-07-26 07:51:58 +02:00
committed by Lorenz Meier
parent 4d01883f75
commit 1e610894b9
+3 -2
View File
@@ -315,8 +315,9 @@ public:
*time_us = _time_last_imu;
}
// Copy the magnetic declination that we wish to save to the EKF2_MAG_DECL parameter for the next startup
void copy_mag_decl_deg(float *val)
// Get the value of magnetic declination in degrees to be saved for use at the next startup
// At the next startup, set param.mag_declination_deg to the value saved
void get_mag_decl_deg(float *val)
{
*val = _mag_declination_to_save_deg;
}