documentation checked and edit

for all files in lib folder
2023-10-12 18:45:12 +02:00
parent 61a95e4601
commit db74898b72
41 changed files with 1030 additions and 569 deletions
@@ -48,7 +48,7 @@ public:
     *
     * @param pin Pin on the Esp from the encoder.
     * @param diameter Diameter of the wheel in meters.
-     * @param steps Encodersteps for a complete wheel rotation.
+     * @param steps EncoderSteps for a complete wheel rotation.
     */
    Speedometer(uint8_t pin, double diameter, uint16_t steps);

@@ -78,12 +78,24 @@ public:
    Direction getDirection() const { return this->currentDirection; }

    /**
-     * @brief Get the calculated speed of the Wheel
+     * @brief Get the calculated speed of the wheel
     *
     * @return double speed in m/s
     */
    double getSpeed() const { return this->speed; }
+
+    /**
+     * @brief Get the calculated speed of the wheel
+     *
+     * @return double speed in rad/s
+     */
    double getSpeedRad() const { return this->rad; };
+
+    /**
+     * @brief Get the calculated average speed of the wheel
+     *
+     * @return double speed in m/s
+     */
    double getAvgSpeed() const;

    /**