view monitor kommentiert

control/src/drv/commit_hash.h

@@ -1,4 +1,4 @@
 #ifndef COMMIT_HASH_H
 #define COMMIT_HASH_H
-const char COMMIT_HASH[] = "be3545fcbb7c7a41ec40d489efc952369f81bf5a";
+const char COMMIT_HASH[] = "69e02c20c2eef57a31b513144c7379d63701f01f";
 #endif // COMMIT_HASH_H

control/src/ui/view_monitor.h

@@ -8,23 +8,44 @@
 #include "view_info.h"
 #include "../drv/b15f.h"
 
-/*! View to display all B15 inputs. */
+/**
+ * Klasse für die Anzeige aller analogen & digitalen Eingänge des B15.
+ */
 
 class ViewMonitor : public ViewInfo
 {
 
 public:
+    /**
+     * Standard-Konstruktor ohne Argumente
+     */
     ViewMonitor(void);
+
+    /**
+     * Verarbeitet einen Tastendruck, z.B. Enter = Button angewählt.
+     * \param key gedrückte Taste
+     * \return Call, der nach dem keypress ausgeführt werden soll
+     */
     virtual call_t keypress(int& key) override;
 
 private:
+    /**
+     * Formatiert einen eingelesen Port-Wert in einen Bitstring und Hexadezimalzahlen.
+     * \param b Port-Wert
+     * \return formatierter String
+     */
     std::string fancyDigitalString(uint8_t& b);
+    /**
+     * Formatiert einen eingelesen ADC-Wert und zeigt eine Prozentleiste.
+     * \param b analoger Wert
+     * \return formatierter String
+     */
     std::string fancyAnalogString(uint16_t& v);
 
 protected:
-    virtual void worker(void);
-    volatile bool run_worker = true;
-    std::thread t_worker;
+    virtual void worker(void); //!< Funktion, die vom Worker-Thread ausgeführt, um die Anzeige zu aktualisieren.
+    volatile bool run_worker = true; //!< Legt fest, ob die Schleife im worker() weiterhin fortgeführt werden soll. Bei false bricht die Schleife ab.
+    std::thread t_worker; //!< Worker-Thread
 
 };