doxygen updates

15 files changed, 37 insertions, 12 deletions

diff --git a/include/gadc/gadc.h b/include/gadc/gadc.h
index ce2ad658..f3595f99 100644
--- a/include/gadc/gadc.h
+++ b/include/gadc/gadc.h
@@ -7,10 +7,11 @@
 
 /**
  * @file    include/gadc/gadc.h
- * @brief   GADC - Periodic ADC subsystem header file.
  *
  * @addtogroup GADC
  *
+ * @brief	Module to abstract the very variable ADC interfaces of the underlying systems
+ *
  * @details	The reason why ChibiOS/GFX has it's own ADC abstraction is because
  *			the Chibi-OS drivers are very CPU specific and do not
  *			provide a way across all hardware platforms to create periodic
diff --git a/include/gaudin/gaudin.h b/include/gaudin/gaudin.h
index 3e6f9fe3..f50499a6 100644
--- a/include/gaudin/gaudin.h
+++ b/include/gaudin/gaudin.h
@@ -7,10 +7,11 @@
 
 /**
  * @file    include/gaudin/gaudin.h
- * @brief   GAUDIN - Audio Input subsystem header file.
  *
  * @addtogroup GAUDIN
  *
+ * @brief	Module to read audio inputs (under development)
+ *
  * @{
  */
 
diff --git a/include/gaudout/gaudout.h b/include/gaudout/gaudout.h
index 7d096ba7..ab46e9c5 100644
--- a/include/gaudout/gaudout.h
+++ b/include/gaudout/gaudout.h
@@ -7,10 +7,11 @@
 
 /**
  * @file    include/gaudout/gaudout.h
- * @brief   GAUDOUT - Audio Output subsystem header file.
  *
  * @addtogroup GAUDOUT
  *
+ * @brief	Module to output audio data (under development)
+ *
  * @{
  */
 
diff --git a/include/gdisp/gdisp.h b/include/gdisp/gdisp.h
index 2497801a..931a87cd 100644
--- a/include/gdisp/gdisp.h
+++ b/include/gdisp/gdisp.h
@@ -11,6 +11,8 @@
  *
  * @addtogroup GDISP
  *
+ * @brief		Module to interface graphic / pixel oriented displays
+ *
  * @details		The GDISP module provides high level abstraction to interface pixel oriented graphic displays.
  *
  * @pre			GFX_USE_GDISP must be set to TRUE in gfxconf.h
diff --git a/include/gevent/gevent.h b/include/gevent/gevent.h
index 5868f70f..7fb3c7ca 100644
--- a/include/gevent/gevent.h
+++ b/include/gevent/gevent.h
@@ -7,10 +7,11 @@
 
 /**
  * @file    include/gevent/gevent.h
- * @brief   GEVENT GFX User Event subsystem header file.
  *
  * @addtogroup GEVENT
  *
+ * @brief		Module to build a complete many-to-many event system
+ * 
  * @details		GEVENT provides a simple to use but yet powerful event
  *				system.
  *
diff --git a/include/gfx.h b/include/gfx.h
index 24cc4ac4..951149ad 100644
--- a/include/gfx.h
+++ b/include/gfx.h
@@ -10,6 +10,9 @@
  * @brief   GFX system header file.
  *
  * @addtogroup GFX
+ *
+ * @brief	Main module to glue all the others together
+ *
  * @{
  */
 
diff --git a/include/ginput/ginput.h b/include/ginput/ginput.h
index 610ec45b..a372cc6f 100644
--- a/include/ginput/ginput.h
+++ b/include/ginput/ginput.h
@@ -7,10 +7,11 @@
 
 /**
  * @file    include/ginput/ginput.h
- * @brief   GINPUT GFX User Input subsystem header file.
  *
  * @addtogroup GINPUT
  *
+ * @brief		Module to interface different hardware input sources such as touchscreens
+ *
  * @details		GINPUT provides an easy and common interface to use different input devices
  *				such as touchscreens and mices.
  *
diff --git a/include/gmisc/gmisc.h b/include/gmisc/gmisc.h
index 4bebc984..382fc867 100644
--- a/include/gmisc/gmisc.h
+++ b/include/gmisc/gmisc.h
@@ -9,7 +9,9 @@
  * @file    include/gmisc/gmisc.h
  * @brief   GMISC - Miscellaneous Routines header file.
  *
- * @addtogroup GAUDIN
+ * @addtogroup GMISC
+ *
+ * @brief	Module which contains different features such as array conversions
  *
  * @{
  */
diff --git a/include/gos/gos.h b/include/gos/gos.h
index 54bde39a..e3d524d7 100644
--- a/include/gos/gos.h
+++ b/include/gos/gos.h
@@ -7,10 +7,12 @@
 
 /**
  * @file    include/gos/gos.h
- * @brief   GOS - Operating System Support header file.
+ * @brief   GOS - Operating System Support header file
  *
  * @addtogroup GOS
- * @brief	GOS provides the operating system interface with the GFX library.
+ *
+ * @brief	Module to build a uniform abstraction layer between uGFX and the underlying system
+ *
  * @note	Some of the routines specified below may be implemented simply as
  * 			a macro to the real operating system call.
  * @{
diff --git a/include/gqueue/gqueue.h b/include/gqueue/gqueue.h
index 8ec3c9b9..68cfdc2f 100644
--- a/include/gqueue/gqueue.h
+++ b/include/gqueue/gqueue.h
@@ -10,7 +10,10 @@
  * @brief   GQUEUE header file.
  *
  * @addtogroup GQUEUE
- * @brief	GQUEUE provides queue management. There are 3 types of queues:
+ *
+ * @brief	Module which provides queue management (only internally used)
+ *
+ * @details	There are 3 types of queues:
  * 			<ul><li><b>Asynchronous Queues (ASync) </b> - Queue operations never block</li>
  * 				<li><b>Get Synchronous Queues (GSync) </b> - Queue Get operations block until something is placed in the Queue</li>
  * 				<li><b>Put Synchronous Queues (PSync)</b> - Queue Put operations block until the element is removed from the Queue</li>
@@ -128,7 +131,7 @@ bool_t gfxQueueFSyncPut(gfxQueueFSync *pqueue, gfxQueueFSyncItem *pitem, delayti
 
 /**
  * @brief	Pop an item from the head of the queue (and remove it from the queue).
- * @detail	This is exactly the same as the Get operation above.
+ * @details	This is exactly the same as the Get operation above.
  *
  * @api
  * @{
diff --git a/include/gtimer/gtimer.h b/include/gtimer/gtimer.h
index 494cc201..2b3991ec 100644
--- a/include/gtimer/gtimer.h
+++ b/include/gtimer/gtimer.h
@@ -7,10 +7,11 @@
 
 /**
  * @file    include/gtimer/gtimer.h
- * @brief   GTIMER GFX User Timer subsystem header file.
  *
  * @addtogroup GTIMER
  *
+ * @brief	Module which provides software based timers for user-space applications
+ *
  * @details	The reason why ChibiOS/GFX has it's own timer abstraction is because
  *			virtual timers provided by ChibiOS/RT are interrupt context only.
  *			While great for what they are designed for, they make coding of the input
diff --git a/include/gwin/class_gwin.h b/include/gwin/class_gwin.h
index 3be496b1..02ffdf52 100644
--- a/include/gwin/class_gwin.h
+++ b/include/gwin/class_gwin.h
@@ -155,6 +155,8 @@ extern "C" {
  * @param[in]	vmt		The virtual method table for the GWIN object
  * @param[in]	flags	The default flags to use
  *
+ * @return	The GHandle of the created window
+ *
  * @notapi
  */
 GHandle _gwindowCreate(GWindowObject *pgw, const GWindowInit *pInit, const gwinVMT *vmt, uint16_t flags);
@@ -167,6 +169,8 @@ GHandle _gwindowCreate(GWindowObject *pgw, const GWindowInit *pInit, const gwinV
 	 * @param[in]	pInit	The user initialization parameters
 	 * @param[in]	vmt		The virtual method table for the Widget object
 	 *
+	 * @return	The GHandle of the created widget
+ 	 *
 	 * @notapi
 	 */
 	GHandle _gwidgetCreate(GWidgetObject *pgw, const GWidgetInit *pInit, const gwidgetVMT *vmt);
diff --git a/include/gwin/gwin.h b/include/gwin/gwin.h
index 53f5e205..e09fd2e8 100644
--- a/include/gwin/gwin.h
+++ b/include/gwin/gwin.h
@@ -7,7 +7,6 @@
 
 /**
  * @file    include/gwin/gwin.h
- * @brief   GWIN Graphic window subsystem header file.
  *
  * @defgroup Window Window
  * @ingroup GWIN
diff --git a/include/gwin/options.h b/include/gwin/options.h
index 5a90dacd..be46c3ee 100644
--- a/include/gwin/options.h
+++ b/include/gwin/options.h
@@ -10,6 +10,8 @@
  * @brief   GWIN sub-system options header file.
  *
  * @addtogroup GWIN
+ * @brief	Module which provides a complete GUI toolkit based on widgets
+ * 
  * @{
  */
 
diff --git a/include/tdisp/tdisp.h b/include/tdisp/tdisp.h
index c05d574f..9f264b25 100644
--- a/include/tdisp/tdisp.h
+++ b/include/tdisp/tdisp.h
@@ -11,6 +11,8 @@
  *

  * @addtogroup TDISP

  *

+ * @brief		Module to drive character / dot matrix based displays

+ * 

  * @details		The TDISP module provides high level abstraction to interface pixel oriented graphic displays.

  *				Due the TDISP module is completely encapsulated from the other modules, it's very fast and lightweight.

  *