diff --git a/control/src/commit_hash.h b/control/src/commit_hash.h index e9bbe3e..6332348 100644 --- a/control/src/commit_hash.h +++ b/control/src/commit_hash.h @@ -1,4 +1,4 @@ #ifndef COMMIT_HASH_H #define COMMIT_HASH_H -const char COMMIT_HASH[] = "e016a52459314099549511bb1fed60b3e8f58fa3"; +const char COMMIT_HASH[] = "a43c1610917fa01cb5fb07edbb2090d01fb846f7"; #endif // COMMIT_HASH_H diff --git a/control/src/drv/b15f.h b/control/src/drv/b15f.h index 5fea77e..978987f 100644 --- a/control/src/drv/b15f.h +++ b/control/src/drv/b15f.h @@ -332,6 +332,7 @@ private: /** * Wirft eine Exception, falls der Code ungleich dem erwarteten Wert ist. + * Wird durch den Wrapper assertCode(code, expectation) aufgerufen. * \throws DriverException */ template @@ -343,6 +344,7 @@ private: /** * Wirft eine Exception, falls die Request die falsche Länge hat. + * Wird durch den Wrapper assertRequestLength(rq, rq_num) aufgerufen. * \throws DriverException */ template diff --git a/control/src/drv/dot.h b/control/src/drv/dot.h index 48f3493..6c2e5f4 100644 --- a/control/src/drv/dot.h +++ b/control/src/drv/dot.h @@ -18,23 +18,23 @@ public: Dot(uint16_t x, uint16_t y, uint8_t curve); /** - * Returns the x coordinate. + * \return the x coordinate */ uint16_t getX(void) const; /** - * Returns the y coordinate. + * \return the y coordinate */ uint16_t getY(void) const; /** - * Returns the curve index. + * \return the curve index */ uint8_t getCurve(void) const; private: - uint16_t x, y; - uint8_t curve; + const uint16_t x, y; //!< coordinates of this dot + const uint8_t curve; //!< curve index of this dot }; diff --git a/control/src/drv/plottyfile.h b/control/src/drv/plottyfile.h index 16a38d3..e26ce45 100644 --- a/control/src/drv/plottyfile.h +++ b/control/src/drv/plottyfile.h @@ -194,16 +194,16 @@ private: uint16_t ref_y = 1023; uint16_t para_first = 1; uint16_t para_stepwidth = 1; - std::string unit_x; - std::string desc_x; - std::string unit_y; - std::string desc_y; - std::string unit_para; - std::string desc_para; + std::string unit_x; //!< unit name for x-axis + std::string desc_x; //!< description for x-axis + std::string unit_y; //!< unit name for y-axis + std::string desc_y; //!< description for y-axis + std::string unit_para; //!< unit name for parameter + std::string desc_para; //!< description for parameter const uint8_t eof = 0xD; - constexpr static uint8_t STR_LEN_SHORT = 10; - constexpr static uint8_t STR_LEN_LARGE = 20; + constexpr static uint8_t STR_LEN_SHORT = 10; //!< string length for short string in header + constexpr static uint8_t STR_LEN_LARGE = 20; //!< string length for large string in header }; #endif // PLOTTYFILE_H