From a75653f7a1dbe7fc8317fcc3d8d2331855d3a036 Mon Sep 17 00:00:00 2001 From: Joel Bodenmann Date: Tue, 18 Dec 2012 22:55:03 +0100 Subject: [PATCH] some more doxygen --- include/ginput/dial.h | 7 +++++++ include/ginput/mouse.h | 7 +++++++ include/ginput/toggle.h | 8 ++++++++ 3 files changed, 22 insertions(+) diff --git a/include/ginput/dial.h b/include/ginput/dial.h index 80855b54..a765f7f2 100644 --- a/include/ginput/dial.h +++ b/include/ginput/dial.h @@ -23,6 +23,13 @@ * * @defgroup 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 diff --git a/include/ginput/mouse.h b/include/ginput/mouse.h index ef268be4..bb4bb547 100644 --- a/include/ginput/mouse.h +++ b/include/ginput/mouse.h @@ -23,6 +23,13 @@ * * @defgroup Mouse * @ingroup GINPUT + * + * @details GINPUT allows it to easily interface touchscreens and mices to + * your application. + * + * @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 + * * @{ */ #ifndef _GINPUT_MOUSE_H diff --git a/include/ginput/toggle.h b/include/ginput/toggle.h index 889b9596..078aa92a 100644 --- a/include/ginput/toggle.h +++ b/include/ginput/toggle.h @@ -23,8 +23,16 @@ * * @defgroup Toggle * @ingroup GINPUT + * + * @details GINPUT allows it to interface toggle buttons easily to your + * application. + * + * @pre GFX_USE_GINPUT must be set to TRUE in your gfxconf.h + * @pre GINPUT_NEED_TOGGLE must be set to TRUE in your gfxconf.h + * * @{ */ + #ifndef _GINPUT_TOGGLE_H #define _GINPUT_TOGGLE_H