Generate API docs from source code comments (#2491)

[qmk_firmware.git] / tmk_core / common / bootmagic.c

diff --git a/tmk_core/common/bootmagic.c b/tmk_core/common/bootmagic.c
index 2c6bcbae56fccafae40a627ce0e47ceb4fcce37c..9f79fb8eedba647517dc4fdf054a5e395b1ca131 100644 (file)
--- a/tmk_core/common/bootmagic.c
+++ b/tmk_core/common/bootmagic.c
@@ -12,6 +12,10 @@
 
 keymap_config_t keymap_config;
 
+/** \brief Bootmagic
+ *
+ * FIXME: needs doc
+ */
 void bootmagic(void)
 {
     /* check signature */
@@ -102,6 +106,10 @@ void bootmagic(void)
     }
 }
 
+/** \brief Scan Keycode
+ *
+ * FIXME: needs doc
+ */
 static bool scan_keycode(uint8_t keycode)
 {
     for (uint8_t r = 0; r < MATRIX_ROWS; r++) {
@@ -117,9 +125,13 @@ static bool scan_keycode(uint8_t keycode)
     return false;
 }
 
+/** \brief Bootmagic Scan Keycode
+ *
+ * FIXME: needs doc
+ */
 bool bootmagic_scan_keycode(uint8_t keycode)
 {
     if (!scan_keycode(BOOTMAGIC_KEY_SALT)) return false;
 
     return scan_keycode(keycode);
-}
\ No newline at end of file
+}