Improve sphinx

stm-firmware/adc-meas.c

@@ -18,6 +18,11 @@
  * If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @file adc-meas.c
+ * @brief Implementation of the PT1000 measurement ADC and filtering functions
+ */
+
 #include <reflow-controller/adc-meas.h>
 #include <stm32/stm32f4xx.h>
 #include <cmsis/core_cm4.h>
@@ -30,7 +35,13 @@ static float pt1000_offset;
 static float pt1000_sens_dev;
 static bool calibration_active;
 static float filter_alpha;
+
+/**
+ * @brief Filtered PT1000 resistance value.
+ * @note This value is not yet calibrated. Use @ref adc_pt1000_get_current_resistance to get this value with calibration.
+ */
 static volatile float pt1000_res_raw_lf;
+
 static volatile int * volatile streaming_flag_ptr = NULL;
 static uint32_t filter_startup_cnt;
 static volatile float adc_pt1000_raw_reading_hf;
@@ -41,6 +52,9 @@ volatile float * volatile stream_buffer = NULL;
 volatile uint32_t stream_count;
 volatile uint32_t stream_pos;
 
+/**
+ * @brief Conversion macro: ADC value to resistance
+ */
 #define ADC_TO_RES(adc) ((float)(adc) / 4096.0f * 2500.0f)
 
 static inline void adc_pt1000_stop_sample_frequency_timer()

stm-firmware/include/reflow-controller/adc-meas.h

@@ -18,6 +18,10 @@
  * If not, see <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @file adc-meas.h
+ */
+
 #ifndef __ADCMEAS_H__
 #define __ADCMEAS_H__