diff options
| -rw-r--r-- | docs/src/gwin.dox | 4 | ||||
| -rw-r--r-- | include/gwin/button.h | 6 | ||||
| -rw-r--r-- | include/gwin/console.h | 6 | ||||
| -rw-r--r-- | include/gwin/graph.h | 4 | ||||
| -rw-r--r-- | include/gwin/gwin.h | 8 |
5 files changed, 27 insertions, 1 deletions
diff --git a/docs/src/gwin.dox b/docs/src/gwin.dox index b8ea478a..7f5b4115 100644 --- a/docs/src/gwin.dox +++ b/docs/src/gwin.dox @@ -20,7 +20,9 @@ /**
* @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
* has to be set up correctly.
*/
diff --git a/include/gwin/button.h b/include/gwin/button.h index 6d6e27db..6bab6b25 100644 --- a/include/gwin/button.h +++ b/include/gwin/button.h @@ -24,6 +24,12 @@ * @defgroup Button
* @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
* @{
*/
diff --git a/include/gwin/console.h b/include/gwin/console.h index fba27584..99c9232c 100644 --- a/include/gwin/console.h +++ b/include/gwin/console.h @@ -24,6 +24,12 @@ * @defgroup Console
* @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
+ *
* @{
*/
diff --git a/include/gwin/graph.h b/include/gwin/graph.h index a8a84a1d..e7f86d58 100644 --- a/include/gwin/graph.h +++ b/include/gwin/graph.h @@ -25,6 +25,10 @@ * @defgroup Graph
* @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
+ *
* @{
*/
diff --git a/include/gwin/gwin.h b/include/gwin/gwin.h index 5d5f5a5a..b71796d3 100644 --- a/include/gwin/gwin.h +++ b/include/gwin/gwin.h @@ -24,6 +24,14 @@ * @defgroup Window
* @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
+ *
* @{
*/
|