aboutsummaryrefslogtreecommitdiffstats
path: root/src/ginput
diff options
context:
space:
mode:
authorJoel Bodenmann <joel@seriouslyembedded.com>2015-11-07 16:33:28 +0100
committerJoel Bodenmann <joel@seriouslyembedded.com>2015-11-07 16:33:28 +0100
commit6397a56e0beddf179786e093b08bcf0cbe71fea1 (patch)
tree12a15acf8c2c69db37abad2165b621b5bc244382 /src/ginput
parent778b23bdfdb6805e8aa4f9a0cea3a5b99c50cd46 (diff)
downloaduGFX-6397a56e0beddf179786e093b08bcf0cbe71fea1.tar.gz
uGFX-6397a56e0beddf179786e093b08bcf0cbe71fea1.tar.bz2
uGFX-6397a56e0beddf179786e093b08bcf0cbe71fea1.zip
Doxygen
Diffstat (limited to 'src/ginput')
-rw-r--r--src/ginput/ginput_dial.h3
-rw-r--r--src/ginput/ginput_keyboard.h4
-rw-r--r--src/ginput/ginput_mouse.h6
-rw-r--r--src/ginput/ginput_toggle.h3
4 files changed, 10 insertions, 6 deletions
diff --git a/src/ginput/ginput_dial.h b/src/ginput/ginput_dial.h
index 88a2e165..e0292cb6 100644
--- a/src/ginput/ginput_dial.h
+++ b/src/ginput/ginput_dial.h
@@ -7,11 +7,12 @@
/**
* @file src/ginput/ginput_dial.h
- * @brief GINPUT GFX User Input subsystem header file.
*
* @defgroup Dial Dial
* @ingroup GINPUT
*
+ * @brief Sub-Module to handle physical controls that provide a range value (eg. potentiometers and rotary encoders).
+ *
* @details A dial provides a powerful way to navigate through menus
* on a display.
*
diff --git a/src/ginput/ginput_keyboard.h b/src/ginput/ginput_keyboard.h
index 40691a0d..a80e23d0 100644
--- a/src/ginput/ginput_keyboard.h
+++ b/src/ginput/ginput_keyboard.h
@@ -7,10 +7,12 @@
/**
* @file src/ginput/ginput_keyboard.h
- * @brief GINPUT GFX User Input subsystem header file.
*
* @defgroup Keyboard Keyboard
* @ingroup GINPUT
+ *
+ * @brief Sub-Module to handle physical keyboards.
+ *
* @{
*/
diff --git a/src/ginput/ginput_mouse.h b/src/ginput/ginput_mouse.h
index e59b2dae..24005fe6 100644
--- a/src/ginput/ginput_mouse.h
+++ b/src/ginput/ginput_mouse.h
@@ -7,13 +7,13 @@
/**
* @file src/ginput/ginput_mouse.h
- * @brief GINPUT GFX User Input subsystem header file for mouse and touch.
*
* @defgroup Mouse Mouse
* @ingroup GINPUT
*
- * @details GINPUT allows it to easily interface touchscreens and mices to
- * your application.
+ * @brief Sub-Module to handle touchscreens and mices.
+ *
+ * @details Both resistive and capacitive touchscreens are supported.
*
* @pre GFX_USE_GINPUT must be set to TRUE in your gfxconf.h
* @pre GINPUT_NEED_MOUSE must be set to TRUE in your gfxconf.h
diff --git a/src/ginput/ginput_toggle.h b/src/ginput/ginput_toggle.h
index 7fc075d6..ad896bf6 100644
--- a/src/ginput/ginput_toggle.h
+++ b/src/ginput/ginput_toggle.h
@@ -7,11 +7,12 @@
/**
* @file src/ginput/ginput_toggle.h
- * @brief GINPUT GFX User Input subsystem header file.
*
* @defgroup Toggle Toggle
* @ingroup GINPUT
*
+ * @brief Sub-Module to handle physical controls that provide provide a digital value (on/off, pressed/released, 1/0, ...).
+ *
* @details GINPUT allows it to interface toggle buttons easily to your
* application.
*