Reworking the GWIN doxygen documentation.

3 files changed, 80 insertions, 0 deletions

diff --git a/docs/src/containers.dox b/docs/src/containers.dox
new file mode 100644
index 00000000..3d0a6368
--- /dev/null
+++ b/docs/src/containers.dox
@@ -0,0 +1,21 @@
+/*
+ * 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	Containers Containers
+ * @ingroup 	GWIN
+ *
+ * @details		Containers are a "super-class" of a widget. Containers can have
+ *				children windows which they can place within their borders. Containers
+ *				control the visibility and enabled state of their children. By making
+ *				a container invisible you make all its children invisible. Similiarly
+ *				with the enabled state.
+ *
+ * @pre			GFX_USE_GWIN must be set to TRUE in your gfxconf.h
+ */
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
+ */
diff --git a/docs/src/windows.dox b/docs/src/windows.dox
new file mode 100644
index 00000000..699281a2
--- /dev/null
+++ b/docs/src/windows.dox
@@ -0,0 +1,31 @@
+/*
+ * 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	Windows Windows
+ * @ingroup		GWIN
+ *
+ * @details		The window is the most basic GWIN element. All the other windows,
+ *				widgets and containers are based on this class.
+ *
+ *				A window implements the following properties and attributes:
+ *				<ul>
+ *					<li>Position</li>
+ *					<li>Size</li>
+ *					<li>Foreground color</li>
+ *					<li>Background color</li>
+ *				</ul>
+ *
+ *				Each Window can either be created statically or dynamically.
+ *				Like any other good window system, uGFX provide some standard window
+ *				types such as graphs, consoles, buttons, containers etc. This is done
+ *				through "super-classing" basic windows to provide the extended capabilities.
+ *
+ * @pre			GFX_USE_GWIN must be set to TRUE in your gfxconf.h
+ */