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

1 files changed, 17 insertions, 1 deletions

diff --git a/tmk_core/common/chibios/suspend.c b/tmk_core/common/chibios/suspend.c
index 7c3c75387..32ef773e2 100644
--- a/tmk_core/common/chibios/suspend.c
+++ b/tmk_core/common/chibios/suspend.c
@@ -12,11 +12,19 @@
 #include "suspend.h"
 #include "wait.h"
 
+/** \brief suspend idle
+ *
+ * FIXME: needs doc
+ */
 void suspend_idle(uint8_t time) {
         // TODO: this is not used anywhere - what units is 'time' in?
         wait_ms(time);
 }
 
+/** \brief suspend power down
+ *
+ * FIXME: needs doc
+ */
 void suspend_power_down(void) {
         // TODO: figure out what to power down and how
         // shouldn't power down TPM/FTM if we want a breathing LED
@@ -28,6 +36,10 @@ void suspend_power_down(void) {
         wait_ms(17);
 }
 
+/** \brief suspend wakeup condition
+ *
+ * FIXME: needs doc
+ */
 __attribute__ ((weak)) void matrix_power_up(void) {}
 __attribute__ ((weak)) void matrix_power_down(void) {}
 bool suspend_wakeup_condition(void)
@@ -41,7 +53,11 @@ bool suspend_wakeup_condition(void)
     return false;
 }
 
-// run immediately after wakeup
+/** \brief suspend wakeup condition
+ *
+ * run immediately after wakeup
+ * FIXME: needs doc
+ */
 void suspend_wakeup_init(void)
 {
     // clear keyboard state