temperatoru_calibration: reformat comments to use doxygen style

This commit is contained in:
Beat Küng
2017-03-12 00:08:35 +01:00
committed by Lorenz Meier
parent 7cb291aa62
commit 1177ec91e5
@@ -165,16 +165,17 @@ protected:
struct PerSensorData { struct PerSensorData {
float sensor_sample_filt[Dim + 1]; ///< last value is the temperature float sensor_sample_filt[Dim + 1]; ///< last value is the temperature
polyfitter < PolyfitOrder + 1 > P[Dim]; polyfitter < PolyfitOrder + 1 > P[Dim];
unsigned hot_soak_sat = 0; // counter that increments every time the sensor temperature reduces from the last reading unsigned hot_soak_sat = 0; /**< counter that increments every time the sensor temperature reduces
uint32_t device_id = 0; // ID for the sensor being calibrated from the last reading */
bool cold_soaked = uint32_t device_id = 0; ///< ID for the sensor being calibrated
false; // true when the sensor cold soak starting temperature condition had been verified and the starting temperature set bool cold_soaked = false; ///< true when the sensor cold soak starting temperature condition had been
bool hot_soaked = false; // true when the sensor has achieved the specified temperature increase /// verified and the starting temperature set
bool tempcal_complete = false; // true when the calibration has been completed bool hot_soaked = false; ///< true when the sensor has achieved the specified temperature increase
float low_temp = 0.f; // low temperature recorded at start of calibration (deg C) bool tempcal_complete = false; ///< true when the calibration has been completed
float high_temp = 0.f; // highest temperature recorded during calibration (deg C) float low_temp = 0.f; ///< low temperature recorded at start of calibration (deg C)
float ref_temp = float high_temp = 0.f; ///< highest temperature recorded during calibration (deg C)
0.f; // calibration reference temperature, nominally in the middle of the calibration temperature range (deg C) float ref_temp = 0.f; /**< calibration reference temperature, nominally in the middle of the
calibration temperature range (deg C) */
}; };
PerSensorData _data[SENSOR_COUNT_MAX]; PerSensorData _data[SENSOR_COUNT_MAX];