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
This commit is contained in:
parent
f0932a8716
commit
7c9d5ace14
41 changed files with 1892 additions and 97 deletions
|
@ -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) {
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue