aboutsummaryrefslogtreecommitdiffstats
path: root/include/gwin/gwin.h
diff options
context:
space:
mode:
authorAndrew Hannam <andrewh@inmarket.com.au>2013-05-06 14:44:47 +1000
committerAndrew Hannam <andrewh@inmarket.com.au>2013-05-06 14:44:47 +1000
commit3374aa25c6e4e118df670c18eaeefa0f6f29377f (patch)
tree99bdea0be61386bd3ae70c8516198dd857e4db13 /include/gwin/gwin.h
parentbbfeec2dd7b312745856236214c91fce6b9ec22c (diff)
downloaduGFX-3374aa25c6e4e118df670c18eaeefa0f6f29377f.tar.gz
uGFX-3374aa25c6e4e118df670c18eaeefa0f6f29377f.tar.bz2
uGFX-3374aa25c6e4e118df670c18eaeefa0f6f29377f.zip
Reinsertion of doxygen headers
Reinsertion of doxygen headers that got lost in license change
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