diff options
| author | Joel Bodenmann <joel@unormal.org> | 2014-09-28 23:42:53 +0200 |
|---|---|---|
| committer | Joel Bodenmann <joel@unormal.org> | 2014-09-28 23:42:53 +0200 |
| commit | 0253b7df4967b3fee54d9d9a1e588e6da8cd687d (patch) | |
| tree | 2b54acc57c2dcef1cfc6daa12e9142fc5b156d90 /src/ginput | |
| parent | 8d7bbe7e45e47e24074676ca996c0b744b14c959 (diff) | |
| download | uGFX-0253b7df4967b3fee54d9d9a1e588e6da8cd687d.tar.gz uGFX-0253b7df4967b3fee54d9d9a1e588e6da8cd687d.tar.bz2 uGFX-0253b7df4967b3fee54d9d9a1e588e6da8cd687d.zip | |
some more doxygen fixes
Diffstat (limited to 'src/ginput')
| -rw-r--r-- | src/ginput/driver_mouse.h | 29 |
1 files changed, 23 insertions, 6 deletions
diff --git a/src/ginput/driver_mouse.h b/src/ginput/driver_mouse.h index a252bca1..0f4c475a 100644 --- a/src/ginput/driver_mouse.h +++ b/src/ginput/driver_mouse.h @@ -17,7 +17,7 @@ #ifndef _LLD_GINPUT_MOUSE_H #define _LLD_GINPUT_MOUSE_H -#if GINPUT_NEED_MOUSE || defined(__DOXYGEN__) +#if GINPUT_NEED_MOUSE //|| defined(__DOXYGEN__) // Include the GDRIVER infrastructure #include "src/gdriver/sys_defs.h" @@ -108,19 +108,36 @@ typedef struct GMouseVMT { extern "C" { #endif /** - * @brief Routines needed by the general driver VMT - * @note These routines are provided by the high level code for - * use in the GMouseVMT.d structure. + * @brief Initialize a mouse driver + * + * @param[in] g The mouse driver + * @param[in] display The display to which the mouse shall be assigned + * @param[in] driverinstance The driver instance ToDo: Add some more details + * @param[in] systeminstance The mouse instance ToDo: Add some more details * * @return TRUE on success, FALSE otherwise * * @notapi - * @{ */ bool_t _gmouseInitDriver(GDriver *g, void *display, unsigned driverinstance, unsigned systeminstance); + + /** + * @brief Routine that is called after initialization + * + * @param[in] g The mouse driver + * + * @notapi + */ void _gmousePostInitDriver(GDriver *g); + + /** + * @brief Deinitialize a mouse driver + * + * @param[in] g The mouse driver + * + * @notapi + */ void _gmouseDeInitDriver(GDriver *g); - /** @} */ /** * @brief Wakeup the high level code so that it attempts another read |