diff options
| author | Joel Bodenmann <joel@unormal.org> | 2012-12-18 23:15:47 +0100 |
|---|---|---|
| committer | Joel Bodenmann <joel@unormal.org> | 2012-12-18 23:15:47 +0100 |
| commit | a520a32209cc6057b985bde5d0ad21a8f4186bf2 (patch) | |
| tree | ea0aad71d6370c9ef1840607ed69680dd7f6a159 /include | |
| parent | a75653f7a1dbe7fc8317fcc3d8d2331855d3a036 (diff) | |
| download | uGFX-a520a32209cc6057b985bde5d0ad21a8f4186bf2.tar.gz uGFX-a520a32209cc6057b985bde5d0ad21a8f4186bf2.tar.bz2 uGFX-a520a32209cc6057b985bde5d0ad21a8f4186bf2.zip | |
more doxygen
Diffstat (limited to 'include')
| -rw-r--r-- | include/gdisp/gdisp.h | 5 | ||||
| -rw-r--r-- | include/gevent/gevent.h | 6 | ||||
| -rw-r--r-- | include/ginput/dial.h | 2 | ||||
| -rw-r--r-- | include/ginput/ginput.h | 6 | ||||
| -rw-r--r-- | include/ginput/keyboard.h | 3 | ||||
| -rw-r--r-- | include/ginput/lld/mouse.h | 4 | ||||
| -rw-r--r-- | include/ginput/lld/toggle.h | 4 | ||||
| -rw-r--r-- | include/ginput/mouse.h | 3 | ||||
| -rw-r--r-- | include/ginput/toggle.h | 2 | ||||
| -rw-r--r-- | include/gtimer/gtimer.h | 12 | ||||
| -rw-r--r-- | include/gwin/button.h | 2 | ||||
| -rw-r--r-- | include/gwin/console.h | 2 | ||||
| -rw-r--r-- | include/gwin/graph.h | 2 | ||||
| -rw-r--r-- | include/gwin/gwin.h | 2 |
14 files changed, 45 insertions, 10 deletions
diff --git a/include/gdisp/gdisp.h b/include/gdisp/gdisp.h index 117f865a..f8d5745f 100644 --- a/include/gdisp/gdisp.h +++ b/include/gdisp/gdisp.h @@ -23,6 +23,11 @@ * @brief GDISP Graphic Driver subsystem header file.
*
* @addtogroup GDISP
+ *
+ * @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 a68a5fc0..6acfac01 100644 --- a/include/gevent/gevent.h +++ b/include/gevent/gevent.h @@ -22,6 +22,12 @@ * @brief GEVENT GFX User Event subsystem header file.
*
* @addtogroup GEVENT
+ *
+ * @details GEVENT provides a simple to use but yet powerful event
+ * system.
+ *
+ * @pre GFX_USE_GEVENT must be set to TRUE in your gfxconf.h
+ *
* @{
*/
#ifndef _GEVENT_H
diff --git a/include/ginput/dial.h b/include/ginput/dial.h index a765f7f2..5679685e 100644 --- a/include/ginput/dial.h +++ b/include/ginput/dial.h @@ -21,7 +21,7 @@ * @file include/ginput/dial.h
* @brief GINPUT GFX User Input subsystem header file.
*
- * @defgroup Dial
+ * @defgroup Dial Dial
* @ingroup GINPUT
*
* @details A dial provides a powerful way to navigate through menus
diff --git a/include/ginput/ginput.h b/include/ginput/ginput.h index ec8acca7..59f7640c 100644 --- a/include/ginput/ginput.h +++ b/include/ginput/ginput.h @@ -22,6 +22,12 @@ * @brief GINPUT GFX User Input subsystem header file.
*
* @addtogroup GINPUT
+ *
+ * @details GINPUT provides an easy and common interface to use different input devices
+ * such as touchscreens and mices.
+ *
+ * @pre GFX_USE_GINPUT must be set to TRUE in your gfxconf.h
+ *
* @{
*/
#ifndef _GINPUT_H
diff --git a/include/ginput/keyboard.h b/include/ginput/keyboard.h index 756b78e4..9f5df32e 100644 --- a/include/ginput/keyboard.h +++ b/include/ginput/keyboard.h @@ -21,10 +21,11 @@ * @file include/ginput/keyboard.h
* @brief GINPUT GFX User Input subsystem header file.
*
- * @defgroup Keyboard
+ * @defgroup Keyboard Keyboard
* @ingroup GINPUT
* @{
*/
+
#ifndef _GINPUT_KEYBOARD_H
#define _GINPUT_KEYBOARD_H
diff --git a/include/ginput/lld/mouse.h b/include/ginput/lld/mouse.h index 1b956c78..5f4ba52c 100644 --- a/include/ginput/lld/mouse.h +++ b/include/ginput/lld/mouse.h @@ -21,10 +21,11 @@ * @file include/ginput/lld/mouse.h
* @brief GINPUT LLD header file for mouse/touch drivers.
*
- * @defgroup Mouse
+ * @defgroup Mouse Mouse
* @ingroup GINPUT
* @{
*/
+
#ifndef _LLD_GINPUT_MOUSE_H
#define _LLD_GINPUT_MOUSE_H
@@ -117,3 +118,4 @@ extern "C" { #endif /* _LLD_GINPUT_MOUSE_H */
/** @} */
+
diff --git a/include/ginput/lld/toggle.h b/include/ginput/lld/toggle.h index 77f6b346..a75a670f 100644 --- a/include/ginput/lld/toggle.h +++ b/include/ginput/lld/toggle.h @@ -21,10 +21,11 @@ * @file include/ginput/lld/toggle.h
* @brief GINPUT header file for toggle drivers.
*
- * @defgroup Toggle
+ * @defgroup Toggle Toggle
* @ingroup GINPUT
* @{
*/
+
#ifndef _LLD_GINPUT_TOGGLE_H
#define _LLD_GINPUT_TOGGLE_H
@@ -69,3 +70,4 @@ extern "C" { #endif /* _LLD_GINPUT_TOGGLE_H */
/** @} */
+
diff --git a/include/ginput/mouse.h b/include/ginput/mouse.h index bb4bb547..5385ff17 100644 --- a/include/ginput/mouse.h +++ b/include/ginput/mouse.h @@ -21,7 +21,7 @@ * @file include/ginput/mouse.h
* @brief GINPUT GFX User Input subsystem header file for mouse and touch.
*
- * @defgroup Mouse
+ * @defgroup Mouse Mouse
* @ingroup GINPUT
*
* @details GINPUT allows it to easily interface touchscreens and mices to
@@ -32,6 +32,7 @@ *
* @{
*/
+
#ifndef _GINPUT_MOUSE_H
#define _GINPUT_MOUSE_H
diff --git a/include/ginput/toggle.h b/include/ginput/toggle.h index 078aa92a..bec4ed32 100644 --- a/include/ginput/toggle.h +++ b/include/ginput/toggle.h @@ -21,7 +21,7 @@ * @file include/ginput/toggle.h
* @brief GINPUT GFX User Input subsystem header file.
*
- * @defgroup Toggle
+ * @defgroup Toggle Toggle
* @ingroup GINPUT
*
* @details GINPUT allows it to interface toggle buttons easily to your
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
diff --git a/include/gwin/button.h b/include/gwin/button.h index 6bab6b25..698c840a 100644 --- a/include/gwin/button.h +++ b/include/gwin/button.h @@ -21,7 +21,7 @@ * @file include/gwin/button.h
* @brief GWIN Graphic window subsystem header file.
*
- * @defgroup Button
+ * @defgroup Button Button
* @ingroup GWIN
*
* @details GWIN allows it to easily create buttons with different styles
diff --git a/include/gwin/console.h b/include/gwin/console.h index 99c9232c..9fa867c8 100644 --- a/include/gwin/console.h +++ b/include/gwin/console.h @@ -21,7 +21,7 @@ * @file include/gwin/console.h
* @brief GWIN Graphic window subsystem header file.
*
- * @defgroup Console
+ * @defgroup Console Console
* @ingroup GWIN
*
* @details GWIN allows it to create a console/terminal like window.
diff --git a/include/gwin/graph.h b/include/gwin/graph.h index e7f86d58..155fd9a9 100644 --- a/include/gwin/graph.h +++ b/include/gwin/graph.h @@ -22,7 +22,7 @@ * @file include/gwin/graph.h
* @brief GWIN GRAPH module header file.
*
- * @defgroup Graph
+ * @defgroup Graph Graph
* @ingroup GWIN
*
* @details GWIN allows it to easily draw graphs.
diff --git a/include/gwin/gwin.h b/include/gwin/gwin.h index b71796d3..e109dd83 100644 --- a/include/gwin/gwin.h +++ b/include/gwin/gwin.h @@ -21,7 +21,7 @@ * @file include/gwin/gwin.h
* @brief GWIN Graphic window subsystem header file.
*
- * @defgroup Window
+ * @defgroup Window Window
* @ingroup GWIN
*
* @details GWIN provides a basic window manager which allows it to easily
|