Generate API docs from source code comments (#2491)

[qmk_firmware.git] / tmk_core / common / chibios / bootloader.c

diff --git a/tmk_core/common/chibios/bootloader.c b/tmk_core/common/chibios/bootloader.c
index 2dd3ade34ea01aeccdf2089ace83e6595e8a5c07..f9895237b9bc5c49c296547e7f19cbb93bf656cf 100644 (file)
--- a/tmk_core/common/chibios/bootloader.c
+++ b/tmk_core/common/chibios/bootloader.c
@@ -13,11 +13,19 @@ extern uint32_t __ram0_end__;
 #define MAGIC_ADDR (unsigned long*)(SYMVAL(__ram0_end__) - 4)
 
 
+/** \brief Jump to the bootloader
+ *
+ * FIXME: needs doc
+ */
 void bootloader_jump(void) {
   *MAGIC_ADDR = BOOTLOADER_MAGIC; // set magic flag => reset handler will jump into boot loader
    NVIC_SystemReset();
 }
 
+/** \brief Enter bootloader mode if requested
+ *
+ * FIXME: needs doc
+ */
 void enter_bootloader_mode_if_requested(void)  {
   unsigned long* check = MAGIC_ADDR;
   if(*check == BOOTLOADER_MAGIC)  {