More work on doxygen module structure

common/app/app.h

@@ -1,12 +1,10 @@
+#ifndef APP_H
+#define APP_H
+
 /**
  * @defgroup app Application
  * The App Module contains the effective, platform independent application.
  */
-
-
-/**
- * @addtogroup app
- */
 /*@{*/
 
 /**
@@ -21,10 +19,7 @@ void app_init();
  */
 void app_process();
 
-/**
- * @defgroup screens Screens
- * The Screens of the application. \sa Screen
- */
-
 
 /*@}*/
+
+#endif /* APP_H */

common/app/screen_main.h

@@ -1,5 +1,17 @@
 #include "screen.h"
 
+/**
+ * @addtogroup app
+ */
+/*@{*/
+
+/**
+ * @defgroup screens Screens
+ * The Screens of the application. \sa Screen
+ */
+/*@}*/
+
+
 /**
  * @addtogroup screens
  */

common/gui/button.h

@@ -1,6 +1,19 @@
 #ifndef BUTTON_H
 #define BUTTON_H
 
+/**
+ * @defgroup gui Gui
+ * The Gui Module
+ */
+/*@{*/
+
+/**
+ * @defgroup button Button
+ * The Button Gui-Element
+ */
+/*@{*/
+
+
 
 #include "touch.h"
 
@@ -39,6 +52,6 @@ void guiRemoveBitmapButton(BITMAPBUTTON_STRUCT* button);
 void guiRedrawBitmapButton(BITMAPBUTTON_STRUCT* button);
 */
 
-
+/*@}@}*/
 
 #endif /* BUTTON_H */

common/gui/checkbox.h

@@ -1,3 +1,17 @@
+#ifndef CHECKBOX_H
+#define CHECKBOX_H
+
+/**
+ * @addtogroup gui
+ */
+/*@{*/
+
+/**
+ * @defgroup checkbox Checkbox
+ * The Checkbox Gui-Element
+ */
+/*@{*/
+
 
 typedef void (*CHECKBOX_CALLBACK)(void *checkbox, bool checked);	//!< Function pointer used...
 typedef struct {
@@ -13,3 +27,7 @@ void gui_checkbox_remove(CHECKBOX_STRUCT* checkbox);
 void gui_checkbox_update(CHECKBOX_STRUCT* checkbox);
 void gui_checkbox_redraw(CHECKBOX_STRUCT* checkbox);
 #define CHECKBOX_WIN_FG_COLOR RGB(32,161,34)
+
+/*@}@}*/
+
+#endif /* CHECKBOX_H */

common/gui/numupdown.h

@@ -1,3 +1,18 @@
+#ifndef NUMUPDOWN_H
+#define NUMUPDOWN_H
+
+/**
+ * @addtogroup gui
+ */
+/*@{*/
+
+/**
+ * @defgroup numupdown NummericUpDown
+ * The NummericUpDown Gui Element
+ */
+/*@{*/
+
+
 #include "button.h"
 
 typedef void (*NUMUPDOWN_CALLBACK)(void *numupdown, int16_t value);	//!< Function pointer used...
@@ -20,3 +35,7 @@ bool gui_numupdown_add(NUMUPDOWN_STRUCT* numupdown);
 void gui_numupdown_remove(NUMUPDOWN_STRUCT* numupdown);
 void gui_numupdown_update(NUMUPDOWN_STRUCT* numupdown);
 void gui_numupdown_redraw(NUMUPDOWN_STRUCT* numupdown);
+
+/*@}@}*/
+
+#endif /* NUMUPDOWN_H */

common/gui/screen.h

@@ -1,6 +1,16 @@
 #ifndef SCREEN_H
 #define SCREEN_H
 
+/**
+ * @addtogroup gui
+ */
+/*@{*/
+
+/**
+ * @defgroup screen Screen
+ * The Screen Submodule
+ */
+/*@{*/
 
 #include <stdio.h>
 #include <stdbool.h>
@@ -30,4 +40,6 @@ SCREEN_STRUCT* gui_screen_get_current();
 //Updates/switches the screens. Call this from the app main loop, as fast as you can.
 void gui_screen_update();
 
+/*@}@}*/
+
 #endif /* SCREEN_H */

common/system/system.h

@@ -1,7 +1,38 @@
+#ifndef SYSTEM_H
+#define SYSTEM_H
+
+/**
+ * @defgroup system System
+ * The System Module provides access to delay functions, leds and provides a system init function
+ */
+/*@{*/
+
+
 #include <stdbool.h>
 #include <stdint.h>
 
+/**
+ * Initializes the system. Call this method at the start of your app_init() function and before using any system_* functions
+ * @return true on success
+ */
 bool system_init();
+
+/**
+ * Sleeps for a certain amount of time
+ * @param msec The number of milliseconds to sleep
+ */
 void system_delay(uint32_t msec);
+
+/**
+ * Executes pending system events (like handling usb, timers etc). Call this somewhere in app_process().
+ */
 void system_process();
+
+/**
+ * Toggles a Status Led. Use this function for debugging or to show activity
+ */
 void system_toggle_led();
+
+/*@}*/
+
+#endif /* SYSTEM_H */

common/tft/tft.h

@@ -1,3 +1,5 @@
+#ifndef TFT_H
+#define TFT_H
 
 /**
  * @defgroup tft TFT
@@ -150,3 +152,5 @@ void tft_print_line(uint16_t x, uint16_t y, uint16_t color, uint16_t bgcolor, ui
 void tft_print_formatted(uint16_t x, uint16_t y, uint16_t color, uint16_t bgcolor, uint8_t font, const char* format, ...);
 
 /*@}*/
+
+#endif /* TFT_H */

common/touch/touch.h

@@ -1,3 +1,5 @@
+#ifndef TOUCH_H
+#define TOUCH_H
 
 /**
  * @defgroup touch Touch
@@ -11,9 +13,6 @@
 /*@{*/
 
 
-#ifndef TOUCH_H
-#define TOUCH_H
-
 #include<stdbool.h>
 #include<stdint.h>
 
@@ -108,6 +107,6 @@ void touch_unregister_area(TOUCH_AREA_STRUCT* area);
 POINT_STRUCT touch_get_last_point();
 
 
-#endif /* TOUCH_H */
-
 /*@}*/
+
+#endif /* TOUCH_H */