diff options
| author | Joel Bodenmann <joel@unormal.org> | 2012-12-18 20:06:10 +0100 |
|---|---|---|
| committer | Joel Bodenmann <joel@unormal.org> | 2012-12-18 20:06:10 +0100 |
| commit | e1de308dfabc160f724df51ebebc59bde9717c08 (patch) | |
| tree | 79ed9c2eff59f1d6e5fb28f07effc980b325c13a /include/ginput/keyboard.h | |
| parent | 9c738e00fab50b4bf763fa5254e6542aff7fa78c (diff) | |
| download | uGFX-e1de308dfabc160f724df51ebebc59bde9717c08.tar.gz uGFX-e1de308dfabc160f724df51ebebc59bde9717c08.tar.bz2 uGFX-e1de308dfabc160f724df51ebebc59bde9717c08.zip | |
ginput doxygen
Diffstat (limited to 'include/ginput/keyboard.h')
| -rw-r--r-- | include/ginput/keyboard.h | 20 |
1 files changed, 16 insertions, 4 deletions
diff --git a/include/ginput/keyboard.h b/include/ginput/keyboard.h index cbb11194..086d7f71 100644 --- a/include/ginput/keyboard.h +++ b/include/ginput/keyboard.h @@ -108,11 +108,22 @@ typedef struct GEventKeyboard_t { extern "C" {
#endif
- /* Keyboard Functions */
- GSourceHandle ginputGetKeyboard(uint16_t instance); // Instance = 0 to n-1
+ /**
+ * @brief Create a keyboard input instance
+ *
+ * @param[in] instance The ID of the keyboard input instance (from 0 to 9999)
+ *
+ * @return The source handle of the created input instance
+ */
+ GSourceHandle ginputGetKeyboard(uint16_t instance);
- /* Get the current keyboard button status.
- * Returns FALSE on error (eg invalid instance)
+ /**
+ * @brief Get the current keyboard status
+ *
+ * @param[in] instance The ID of the keyboard input instance
+ * @param[in] pkeyboard The keyboard event struct
+ *
+ * @return Returns FALSE on an error (eg invalid instance)
*/
bool_t ginputGetKeyboardStatus(uint16_t instance, GEventKeyboard *pkeyboard);
@@ -124,3 +135,4 @@ extern "C" { #endif /* _GINPUT_KEYBOARD_H */
/** @} */
+
|