Added doxyfile (doxygen) for the common folder. Started with doxygen comments for app and tft module.
This commit is contained in:
@@ -1,2 +1,30 @@
|
||||
/**
|
||||
* @defgroup app Application
|
||||
* The App Module contains the effective, platform independent application.
|
||||
*/
|
||||
|
||||
|
||||
/**
|
||||
* @addtogroup app
|
||||
*/
|
||||
/*@{*/
|
||||
|
||||
/**
|
||||
* Starts/Initializes the app
|
||||
* This function should be called at the top of the main function of your platform
|
||||
*/
|
||||
void app_init();
|
||||
|
||||
/**
|
||||
* Executes one cycle of the app
|
||||
* Call this function repeatedly from a loop inside the main function
|
||||
*/
|
||||
void app_process();
|
||||
|
||||
/**
|
||||
* @defgroup screens Screens
|
||||
* The Screens of the application. \sa Screen
|
||||
*/
|
||||
|
||||
|
||||
/*@}*/
|
||||
|
||||
@@ -7,7 +7,6 @@
|
||||
|
||||
static BUTTON_STRUCT b_back;
|
||||
|
||||
|
||||
static void b_back_cb(void* button) {
|
||||
gui_screen_back();
|
||||
}
|
||||
|
||||
@@ -1,3 +1,22 @@
|
||||
#include "screen.h"
|
||||
|
||||
/**
|
||||
* @addtogroup screens
|
||||
*/
|
||||
/*@{*/
|
||||
|
||||
/**
|
||||
* @defgroup filetest Filetest
|
||||
* The File-Test Screen tests the filesystem module. It read/writes from/to files and shows a bitmap
|
||||
*/
|
||||
/*@{*/
|
||||
|
||||
|
||||
/**
|
||||
* Returns a pointer to the filetest screen
|
||||
* \sa gui_screen_navigate
|
||||
* @return
|
||||
*/
|
||||
SCREEN_STRUCT* get_screen_filetest();
|
||||
|
||||
/*@}@}*/
|
||||
|
||||
@@ -1,3 +1,23 @@
|
||||
#include "screen.h"
|
||||
|
||||
|
||||
/**
|
||||
* @addtogroup screens
|
||||
*/
|
||||
/*@{*/
|
||||
|
||||
/**
|
||||
* @defgroup guitest Guitest
|
||||
* The Gui-Test Screen tests the gui and the tft module.
|
||||
*/
|
||||
/*@{*/
|
||||
|
||||
|
||||
/**
|
||||
* Returns a pointer to the guitest screen
|
||||
* \sa gui_screen_navigate
|
||||
* @return
|
||||
*/
|
||||
SCREEN_STRUCT* get_screen_guitest();
|
||||
|
||||
/*@}@}*/
|
||||
|
||||
@@ -1,3 +1,22 @@
|
||||
#include "screen.h"
|
||||
|
||||
/**
|
||||
* @addtogroup screens
|
||||
*/
|
||||
/*@{*/
|
||||
|
||||
/**
|
||||
* @defgroup main Main
|
||||
* The Main Screen is the start-screen for the application
|
||||
*/
|
||||
/*@{*/
|
||||
|
||||
|
||||
/**
|
||||
* Returns a pointer to the main screen
|
||||
* \sa gui_screen_navigate
|
||||
* @return
|
||||
*/
|
||||
SCREEN_STRUCT* get_screen_main();
|
||||
|
||||
/*@}@}*/
|
||||
|
||||
@@ -1,3 +1,21 @@
|
||||
#include "screen.h"
|
||||
|
||||
/**
|
||||
* @addtogroup screens
|
||||
*/
|
||||
/*@{*/
|
||||
|
||||
/**
|
||||
* @defgroup pixytest Pixytest
|
||||
* The Pixy-Test Screen tests the pixy module.
|
||||
*/
|
||||
/*@{*/
|
||||
|
||||
/**
|
||||
* Returns a pointer to the pixytest screen
|
||||
* \sa gui_screen_navigate
|
||||
* @return
|
||||
*/
|
||||
SCREEN_STRUCT* get_screen_pixytest();
|
||||
|
||||
/*@}@}*/
|
||||
|
||||
Reference in New Issue
Block a user