doxygen comments

2023-10-12 19:50:26 +02:00
parent f05ab56833
commit 9b8bf22795
11 changed files with 1346 additions and 1014 deletions
@@ -1,22 +1,45 @@
-/**
- * @file displayWrapper.h
- * @author Alexander Klein (alex@kleiax.de)
- * @brief 
- * @version 0.1
- * @date 2023-01-08
- * 
- * @copyright Copyright (c) 2023
- * 
- */
-
-#ifndef DISPLAY_WRAPPER_H
-#define DISPLAY_WRAPPER_H
-
-class DisplayWrapper {
-    public:
-		virtual void clear() = 0;
-        virtual void setCursor(uint8_t row, uint8_t line) = 0;
-        virtual void print(const char *str) = 0;
-};
-
-#endif // DISPLAY_WRAPPER_H
+/**
+ * @file displayWrapper.h
+ * @author Alexander Klein (alex@kleiax.de)
+ * @brief Contains a interface to presents a display
+ * @version 0.1
+ * @date 2023-01-08
+ *
+ * @copyright Copyright (c) 2023
+ *
+ */
+
+#ifndef DISPLAY_WRAPPER_H
+#define DISPLAY_WRAPPER_H
+
+/**
+ * @brief This interface abstracted a display
+ *
+ * With this inteface a display which works with columns
+ * and lines can be wrapped to be accepted by menus.
+ */
+class DisplayWrapper
+{
+public:
+  /**
+   * @brief Remove everything from the display
+   */
+  virtual void clear() = 0;
+
+  /**
+   * @brief Set the cursor to specific line and column
+   *
+   * @param row
+   * @param line
+   */
+  virtual void setCursor(uint8_t row, uint8_t line) = 0;
+
+  /**
+   * @brief Print to the position set by setCursor()
+   *
+   * @param str
+   */
+  virtual void print(const char *str) = 0;
+};
+
+#endif // DISPLAY_WRAPPER_H