aboutsummaryrefslogtreecommitdiffstats
path: root/include/gwin/gwin.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/gwin/gwin.h')
-rw-r--r--include/gwin/gwin.h18
1 files changed, 18 insertions, 0 deletions
diff --git a/include/gwin/gwin.h b/include/gwin/gwin.h
index 1c8672de..43095643 100644
--- a/include/gwin/gwin.h
+++ b/include/gwin/gwin.h
@@ -5,6 +5,24 @@
* http://chibios-gfx.com/license.html
*/
+/**
+ * @file include/gwin/gwin.h
+ * @brief GWIN Graphic window subsystem header file.
+ *
+ * @defgroup Window 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
+ *
+ * @{
+ */
+
#ifndef _GWIN_H
#define _GWIN_H