aboutsummaryrefslogtreecommitdiffstats
path: root/include/ginput/dial.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/ginput/dial.h')
-rw-r--r--include/ginput/dial.h16
1 files changed, 16 insertions, 0 deletions
diff --git a/include/ginput/dial.h b/include/ginput/dial.h
index 5f565a4d..af54952a 100644
--- a/include/ginput/dial.h
+++ b/include/ginput/dial.h
@@ -4,6 +4,22 @@
*
* http://chibios-gfx.com/license.html
*/
+
+/**
+ * @file include/ginput/dial.h
+ * @brief GINPUT GFX User Input subsystem header file.
+ *
+ * @defgroup Dial Dial
+ * @ingroup GINPUT
+ *
+ * @details A dial provides a powerful way to navigate through menus
+ * on a display.
+ *
+ * @pre GFX_USE_GINPUT must be set to TRUE in your gfxconf.h
+ * @pre GINPUT_NEED_DIAL must be set to TRUE in your gfxconf.h
+ *
+ * @{
+ */
#ifndef _GINPUT_DIAL_H
#define _GINPUT_DIAL_H