diff options
| author | Christian Fetzer <fetzer.ch@gmail.com> | 2016-11-10 09:17:52 -0800 |
|---|---|---|
| committer | Garrett Brown <themagnificentmrb@gmail.com> | 2016-11-15 14:56:37 -0800 |
| commit | 0aaaa083b6bf32cfd74eed37e25a190d5c775ab0 (patch) | |
| tree | 76142a06a2d08302a42dd397513137be4918b287 /doxygen_resources | |
| parent | f935b6f95d442e833150e0f7eed56a20b4820411 (diff) | |
[Docs] Add Doxygen documentation for input
Diffstat (limited to 'doxygen_resources')
| -rw-r--r-- | doxygen_resources/pages/mainpage.dox | 21 |
1 files changed, 20 insertions, 1 deletions
diff --git a/doxygen_resources/pages/mainpage.dox b/doxygen_resources/pages/mainpage.dox index 1fe906ba39..2010fca8d4 100644 --- a/doxygen_resources/pages/mainpage.dox +++ b/doxygen_resources/pages/mainpage.dox @@ -130,6 +130,19 @@ Everything around input */ +/*! \defgroup keyboard Keyboard + \ingroup input + + Keyboard input is processed by \ref CInputManager and forwarded to + registered keyboard handlers (e.g. game clients) or as actions to the UI: + + - If no keyboard handlers are registered or if they don't consume events, + the keyboard events are forwarded to the UI via \ref CInputManager::OnKey. + - Clients (e.g. game clients implementing \ref KEYBOARD::IKeyboardHandler) call + \ref CInputManager::RegisterKeyboardHandler to register themselves as eligible + for keyboard input events. +*/ + /*! \defgroup mouse Mouse \ingroup input @@ -137,6 +150,12 @@ */ /*! + \defgroup joystick Joystick + \ingroup input + Everything around joystick +*/ + +/*! \defgroup touch Touch \ingroup input Everything around touch detection @@ -189,4 +208,4 @@ /*! \defgroup windows Windows Kodi windows -*/
\ No newline at end of file +*/ |