More work on doxygen module structure

This commit is contained in:
t-moe
2015-05-11 20:44:56 +02:00
parent a175a2f6b0
commit 08d9fe0c3c
9 changed files with 119 additions and 16 deletions

View File

@@ -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 */

View File

@@ -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 */

View File

@@ -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 */

View File

@@ -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 */