From 7c9d5ace143d3cc6d767a354acde814926d566fd Mon Sep 17 00:00:00 2001 From: skullydazed Date: Wed, 21 Mar 2018 23:50:38 -0700 Subject: Generate API docs from source code comments (#2491) * Generate api docs from source code * Add a bunch of doxygen comments * more doxygen comments * Add the in-progress api docs * script to generate docs from travis * Add doc generation to the travis job * make travis_docs.sh commit the work it does * make sure the docs script exits cleanly --- tmk_core/common/keyboard.c | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) (limited to 'tmk_core/common/keyboard.c') diff --git a/tmk_core/common/keyboard.c b/tmk_core/common/keyboard.c index 001fb00ce..4eff764e2 100644 --- a/tmk_core/common/keyboard.c +++ b/tmk_core/common/keyboard.c @@ -117,19 +117,35 @@ static inline bool has_ghost_in_row(uint8_t row, matrix_row_t rowdata) #endif +/** \brief matrix_setup + * + * FIXME: needs doc + */ __attribute__ ((weak)) void matrix_setup(void) { } +/** \brief keyboard_setup + * + * FIXME: needs doc + */ void keyboard_setup(void) { matrix_setup(); } +/** \brief is_keyboard_master + * + * FIXME: needs doc + */ __attribute__((weak)) bool is_keyboard_master(void) { return true; } +/** \brief keyboard_init + * + * FIXME: needs doc + */ void keyboard_init(void) { timer_init(); matrix_init(); @@ -167,8 +183,16 @@ void keyboard_init(void) { #endif } -/* - * Do keyboard routine jobs: scan matrix, light LEDs, ... +/** \brief Keyboard task: Do keyboard routine jobs + * + * Do routine keyboard jobs: + * + * * scan matrix + * * handle mouse movements + * * run visualizer code + * * handle midi commands + * * light LEDs + * * This is repeatedly called as fast as possible. */ void keyboard_task(void) @@ -274,6 +298,10 @@ MATRIX_LOOP_END: } } +/** \brief keyboard set leds + * + * FIXME: needs doc + */ void keyboard_set_leds(uint8_t leds) { if (debug_keyboard) { debug("keyboard_set_led: "); debug_hex8(leds); debug("\n"); } -- cgit v1.2.3-24-g4f1b