diff options
author | Andrew Hannam <andrewh@inmarket.com.au> | 2013-05-06 14:44:47 +1000 |
---|---|---|
committer | Andrew Hannam <andrewh@inmarket.com.au> | 2013-05-06 14:44:47 +1000 |
commit | 3374aa25c6e4e118df670c18eaeefa0f6f29377f (patch) | |
tree | 99bdea0be61386bd3ae70c8516198dd857e4db13 /include/ginput/lld | |
parent | bbfeec2dd7b312745856236214c91fce6b9ec22c (diff) | |
download | uGFX-3374aa25c6e4e118df670c18eaeefa0f6f29377f.tar.gz uGFX-3374aa25c6e4e118df670c18eaeefa0f6f29377f.tar.bz2 uGFX-3374aa25c6e4e118df670c18eaeefa0f6f29377f.zip |
Reinsertion of doxygen headers
Reinsertion of doxygen headers that got lost in license change
Diffstat (limited to 'include/ginput/lld')
-rw-r--r-- | include/ginput/lld/dial.h | 9 | ||||
-rw-r--r-- | include/ginput/lld/mouse.h | 9 | ||||
-rw-r--r-- | include/ginput/lld/toggle.h | 101 |
3 files changed, 73 insertions, 46 deletions
diff --git a/include/ginput/lld/dial.h b/include/ginput/lld/dial.h index bdcd2c3b..7c16851f 100644 --- a/include/ginput/lld/dial.h +++ b/include/ginput/lld/dial.h @@ -5,6 +5,15 @@ * http://chibios-gfx.com/license.html */ +/** + * @file include/ginput/lld/dial.h + * @brief GINPUT header file for dial drivers. + * + * @defgroup Dial Dial + * @ingroup GINPUT + * @{ + */ + #ifndef _LLD_GINPUT_DIAL_H #define _LLD_GINPUT_DIAL_H diff --git a/include/ginput/lld/mouse.h b/include/ginput/lld/mouse.h index 111e8263..a9e755c4 100644 --- a/include/ginput/lld/mouse.h +++ b/include/ginput/lld/mouse.h @@ -5,6 +5,15 @@ * http://chibios-gfx.com/license.html */ +/** + * @file include/ginput/lld/mouse.h + * @brief GINPUT LLD header file for mouse/touch drivers. + * + * @defgroup Mouse Mouse + * @ingroup GINPUT + * @{ + */ + #ifndef _LLD_GINPUT_MOUSE_H #define _LLD_GINPUT_MOUSE_H diff --git a/include/ginput/lld/toggle.h b/include/ginput/lld/toggle.h index 34aafe32..869b92f8 100644 --- a/include/ginput/lld/toggle.h +++ b/include/ginput/lld/toggle.h @@ -4,49 +4,58 @@ * * http://chibios-gfx.com/license.html */ -
-#ifndef _LLD_GINPUT_TOGGLE_H
-#define _LLD_GINPUT_TOGGLE_H
-
-#if GINPUT_NEED_TOGGLE || defined(__DOXYGEN__)
-
-// Describes how the toggle bits are obtained
-typedef struct GToggleConfig_t {
- void *id;
- unsigned mask;
- unsigned invert;
- iomode_t mode;
-} GToggleConfig;
-
-/*===========================================================================*/
-/* External declarations. */
-/*===========================================================================*/
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
- extern const GToggleConfig GInputToggleConfigTable[GINPUT_TOGGLE_CONFIG_ENTRIES];
-
- void ginput_lld_toggle_init(const GToggleConfig *ptc);
- unsigned ginput_lld_toggle_getbits(const GToggleConfig *ptc);
-
- /* This routine is provided to low level drivers to wakeup a value read from a thread context.
- * Particularly useful if GINPUT_TOGGLE_POLL_PERIOD = TIME_INFINITE
- */
- void ginputToggleWakeup(void);
-
- /* This routine is provided to low level drivers to wakeup a value read from an ISR
- * Particularly useful if GINPUT_TOGGLE_POLL_PERIOD = TIME_INFINITE
- */
- void ginputToggleWakeupI(void);
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif /* GFX_USE_GINPUT && GINPUT_NEED_TOGGLE */
-
-#endif /* _LLD_GINPUT_TOGGLE_H */
-/** @} */
-
+ +/** + * @file include/ginput/lld/toggle.h + * @brief GINPUT header file for toggle drivers. + * + * @defgroup Toggle Toggle + * @ingroup GINPUT + * @{ + */ + +#ifndef _LLD_GINPUT_TOGGLE_H +#define _LLD_GINPUT_TOGGLE_H + +#if GINPUT_NEED_TOGGLE || defined(__DOXYGEN__) + +// Describes how the toggle bits are obtained +typedef struct GToggleConfig_t { + void *id; + unsigned mask; + unsigned invert; + iomode_t mode; +} GToggleConfig; + +/*===========================================================================*/ +/* External declarations. */ +/*===========================================================================*/ + +#ifdef __cplusplus +extern "C" { +#endif + + extern const GToggleConfig GInputToggleConfigTable[GINPUT_TOGGLE_CONFIG_ENTRIES]; + + void ginput_lld_toggle_init(const GToggleConfig *ptc); + unsigned ginput_lld_toggle_getbits(const GToggleConfig *ptc); + + /* This routine is provided to low level drivers to wakeup a value read from a thread context. + * Particularly useful if GINPUT_TOGGLE_POLL_PERIOD = TIME_INFINITE + */ + void ginputToggleWakeup(void); + + /* This routine is provided to low level drivers to wakeup a value read from an ISR + * Particularly useful if GINPUT_TOGGLE_POLL_PERIOD = TIME_INFINITE + */ + void ginputToggleWakeupI(void); + +#ifdef __cplusplus +} +#endif + +#endif /* GFX_USE_GINPUT && GINPUT_NEED_TOGGLE */ + +#endif /* _LLD_GINPUT_TOGGLE_H */ +/** @} */ + |