]> git.donarmstrong.com Git - qmk_firmware.git/commit
Generate API docs from source code comments (#2491)
authorskullydazed <skullydazed@users.noreply.github.com>
Thu, 22 Mar 2018 06:50:38 +0000 (23:50 -0700)
committerJack Humbert <jack.humb@gmail.com>
Thu, 22 Mar 2018 06:50:38 +0000 (02:50 -0400)
commit7c9d5ace143d3cc6d767a354acde814926d566fd
tree1f2b581b6c9f6278a9e180bfcc8dd86b0a7fd2ef
parentf0932a8716dc946322c5ebae7f75eaa275c6220c
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
41 files changed:
.gitignore
.travis.yml
Doxyfile [new file with mode: 0644]
docs/_summary.md
docs/api_defines.md [new file with mode: 0644]
docs/api_input_callback_reg.md [new file with mode: 0644]
docs/api_midi_device.md [new file with mode: 0644]
docs/api_midi_device_setup_process.md [new file with mode: 0644]
docs/api_midi_util.md [new file with mode: 0644]
docs/api_send_functions.md [new file with mode: 0644]
docs/api_sysex_tools.md [new file with mode: 0644]
doxygen-todo [new file with mode: 0644]
tmk_core/common/action.c
tmk_core/common/action_code.h
tmk_core/common/action_layer.c
tmk_core/common/action_macro.c
tmk_core/common/action_tapping.c
tmk_core/common/action_util.c
tmk_core/common/avr/bootloader.c
tmk_core/common/avr/sleep_led.c
tmk_core/common/avr/suspend.c
tmk_core/common/avr/timer.c
tmk_core/common/backlight.c
tmk_core/common/bootmagic.c
tmk_core/common/bootmagic.h
tmk_core/common/chibios/bootloader.c
tmk_core/common/chibios/eeprom.c
tmk_core/common/chibios/suspend.c
tmk_core/common/command.h
tmk_core/common/eeconfig.c
tmk_core/common/keyboard.c
tmk_core/common/keycode.h
tmk_core/common/led.h
tmk_core/common/magic.c
tmk_core/common/report.c
tmk_core/protocol/lufa/lufa.c
tmk_core/protocol/lufa/outputselect.c
util/generate_api_docs.sh [new file with mode: 0755]
util/travis_compiled_push.sh
util/travis_docs.sh [new file with mode: 0644]
util/travis_push.sh [new file with mode: 0644]