Update doxygen comments

2023-02-13 20:36:04 +01:00
parent 1604cb0026
commit deecf7724c
23 changed files with 497 additions and 70 deletions
@@ -100,7 +100,22 @@ class Speedometer {
         */
        double getSpeed();

+        /**
+         * @brief Start calibration
+         * 
+         * This functions stops the loop. So that steps of one manual wheel turn
+         * can measured. Call calibrationMeasurementStop to start the loop and get
+         * the result.
+         */
        void calibrationMeasurementStart();
+
+        /**
+         * @brief Stop calibration
+         * 
+         * Start the loop function and read the past steps.
+         * 
+         * @return uint16_t steps since calibrationMeasurementStart was called
+         */
        uint16_t calibrationMeasurementStop();