From a520a32209cc6057b985bde5d0ad21a8f4186bf2 Mon Sep 17 00:00:00 2001
From: Joel Bodenmann <joel@unormal.org>
Date: Tue, 18 Dec 2012 23:15:47 +0100
Subject: more doxygen

---
 include/gtimer/gtimer.h | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'include/gtimer')

diff --git a/include/gtimer/gtimer.h b/include/gtimer/gtimer.h
index 623120dc..b286d84e 100644
--- a/include/gtimer/gtimer.h
+++ b/include/gtimer/gtimer.h
@@ -22,6 +22,18 @@
  * @brief   GTIMER GFX User Timer subsystem header file.
  *
  * @addtogroup GTIMER
+ *
+ * @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
+ *			drivers much more complex.
+ *			For non-performance critical drivers like these input drivers,  it would also
+ *			hog an in-ordinate amount of critical (interrupt locked) system time.
+ *			This contrary to the goals of a real-time operating system. So a user-land
+ *			(thread based) timer mechanism is also required.
+ *
+ * @pre		GFX_USE_GTIMER must be set to TRUE in your gfxconf.h
+ *
  * @{
  */
 #ifndef _GTIMER_H
-- 
cgit v1.2.3