some more doxygen
This commit is contained in:
parent
6e76ecde18
commit
5c6027d14d
5 changed files with 27 additions and 1 deletions
|
@ -20,7 +20,9 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @addtogroup GWIN
|
* @addtogroup GWIN
|
||||||
* @details The GWIN module provides simple window management.
|
* @details The GWIN module does not only provides simple window manager, but also
|
||||||
|
* different widgets such as a console/terminal, buttons and a module
|
||||||
|
* to draw graphs.
|
||||||
* @details Please note that GWIN is a module ontop of GDISP. Therefore, GDISP
|
* @details Please note that GWIN is a module ontop of GDISP. Therefore, GDISP
|
||||||
* has to be set up correctly.
|
* has to be set up correctly.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -24,6 +24,12 @@
|
||||||
* @defgroup Button
|
* @defgroup Button
|
||||||
* @ingroup GWIN
|
* @ingroup GWIN
|
||||||
*
|
*
|
||||||
|
* @details GWIN allows it to easily create buttons with different styles
|
||||||
|
* and check for different meta states such as: PRESSED, CLICKED,
|
||||||
|
* RELEASED etc.
|
||||||
|
*
|
||||||
|
* @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h
|
||||||
|
* @pre GWIN_NEED_BUTTON must be set to TRUE in your gfxconf.h
|
||||||
* @{
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -24,6 +24,12 @@
|
||||||
* @defgroup Console
|
* @defgroup Console
|
||||||
* @ingroup GWIN
|
* @ingroup GWIN
|
||||||
*
|
*
|
||||||
|
* @details GWIN allows it to create a console/terminal like window.
|
||||||
|
* You can simply use chprintf() to print to the terminal.
|
||||||
|
*
|
||||||
|
* @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h
|
||||||
|
* @pre GWIN_NEED_CONSOLE must be set to TRUE in your gfxconf.h
|
||||||
|
*
|
||||||
* @{
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -25,6 +25,10 @@
|
||||||
* @defgroup Graph
|
* @defgroup Graph
|
||||||
* @ingroup GWIN
|
* @ingroup GWIN
|
||||||
*
|
*
|
||||||
|
* @details GWIN allows it to easily draw graphs.
|
||||||
|
* @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h
|
||||||
|
* @pre GWIN_NEED_GRAPH must be set to TRUE in your gfxconf.h
|
||||||
|
*
|
||||||
* @{
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -24,6 +24,14 @@
|
||||||
* @defgroup Window
|
* @defgroup Window
|
||||||
* @ingroup GWIN
|
* @ingroup GWIN
|
||||||
*
|
*
|
||||||
|
* @details GWIN provides a basic window manager which allows it to easily
|
||||||
|
* create and destroy different windows on runtime. Each window
|
||||||
|
* will have it's own properties such as colors, brushes as well as
|
||||||
|
* it's own drawing origin.
|
||||||
|
* Moving the windows around is not supported yet.
|
||||||
|
*
|
||||||
|
* @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h
|
||||||
|
*
|
||||||
* @{
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue