Finish documention until someone change something

This commit is contained in:
2022-02-15 20:12:50 +01:00
parent 3a2e51713b
commit c8e3344b27
50 changed files with 991 additions and 223 deletions
+5 -5
View File
@@ -1,7 +1,7 @@
/**
* @file speedometer.h
* @author Alexander Klein (alex@kleiax.de)
* @brief A complete implementation to measure wheel speeds with an encoder.
* @brief A implementation to measure wheel speeds with an encoder.
* @version 0.1
* @date 2021-12-09
*
@@ -32,7 +32,7 @@
* @brief A class which use a encoder to calc the speed
*
* This class use ESP32 pulse counter hardware peripheral.
* The calclutaed speed is the average of an amount of last measurments.
* The calculated speed is the average of an amount of last measurements.
*
*/
class Speedometer {
@@ -40,7 +40,7 @@ class Speedometer {
Speedometer();
/**
* @brief Initalize the speedometer
* @brief Initialize the speedometer
*
* @param pinA Pin on the Esp from the encoder.
* @param pinB Pin on the Esp from the encoder.
@@ -63,7 +63,7 @@ class Speedometer {
uint16_t loop();
/**
* @brief Noramly called repeatedly by loop() to calcluate new values.
* @brief Normally called repeatedly by loop() to calculate new values.
*
* Add a new Value to the average and update the speed.
*/
@@ -121,4 +121,4 @@ class Speedometer {
uint32_t last_millis_calc = 0;
};
#endif // SPEEDOMETER_H
#endif // SPEEDOMETER_H