Reworking the GWIN doxygen documentation.

1 files changed, 28 insertions, 0 deletions

diff --git a/docs/src/widgets.dox b/docs/src/widgets.dox
new file mode 100644
index 00000000..24be391d
--- /dev/null
+++ b/docs/src/widgets.dox
@@ -0,0 +1,28 @@
+/*
+ * This file is subject to the terms of the GFX License. If a copy of
+ * the license was not distributed with this file, you can obtain one at:
+ *
+ *              http://ugfx.com/license.html
+ */
+
+/**
+ * @file    	src/gwin/sys_defs.h
+ *
+ * @defgroup 	Widgets Widgets
+ * @ingroup 	GWIN
+ *
+ * @details		Widgets are a "super-class" of a window that provides the
+ *				following extra features:
+ *				<ul>
+ *					<li>Widgets can always redraw themselves
+ *					<li>Widgets are able to accept user input such as from a touchscreen/toggle/dial/keyboard
+ *					<li>Widgets can have their drawing routine overwritten to provide fancier versions of
+ *						the object. For example, their are predefined drawing routines for round buttons,
+ *						image buttons, arrow buttons etc. along with the normal button drawing routine.
+ *					<li>Widgets support a "style". By changing the style you can affect the colours
+ *						used to draw the widget similar to the way you can apply color schemes
+ *						in Windows and Linux.
+ *				</ul>
+ *
+ * @pre			GFX_USE_GWIN must be set to TRUE in your gfxconf.h
+ */