aboutsummaryrefslogtreecommitdiffstats
path: root/include/gwin/button.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/gwin/button.h')
-rw-r--r--include/gwin/button.h16
1 files changed, 16 insertions, 0 deletions
diff --git a/include/gwin/button.h b/include/gwin/button.h
index e56215fa..b96cb83e 100644
--- a/include/gwin/button.h
+++ b/include/gwin/button.h
@@ -5,6 +5,22 @@
* http://chibios-gfx.com/license.html
*/
+/**
+ * @file include/gwin/button.h
+ * @brief GWIN Graphic window subsystem header file.
+ *
+ * @defgroup Button Button
+ * @ingroup GWIN
+ *
+ * @details GWIN allows it to easily create buttons with different styles
+ * and check for different meta states such as: PRESSED, CLICKED,
+ * RELEASED etc.
+ *
+ * @pre GFX_USE_GWIN must be set to TRUE in your gfxconf.h
+ * @pre GWIN_NEED_BUTTON must be set to TRUE in your gfxconf.h
+ * @{
+ */
+
#ifndef _GWIN_BUTTON_H
#define _GWIN_BUTTON_H