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, 16 insertions, 0 deletions

diff --git a/tmk_core/protocol/lufa/outputselect.c b/tmk_core/protocol/lufa/outputselect.c
index 0df5d3b75..42de80612 100644
--- a/tmk_core/protocol/lufa/outputselect.c
+++ b/tmk_core/protocol/lufa/outputselect.c
@@ -20,15 +20,27 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 uint8_t desired_output = OUTPUT_DEFAULT;
 
+/** \brief Set Output
+ *
+ * FIXME: Needs doc
+ */
 void set_output(uint8_t output) {
     set_output_user(output);
     desired_output = output;
 }
 
+/** \brief Set Output User
+ *
+ * FIXME: Needs doc
+ */
 __attribute__((weak))
 void set_output_user(uint8_t output) {
 }
 
+/** \brief Auto Detect Output
+ *
+ * FIXME: Needs doc
+ */
 uint8_t auto_detect_output(void) {
     if (USB_DeviceState == DEVICE_STATE_Configured) {
         return OUTPUT_USB;
@@ -47,6 +59,10 @@ uint8_t auto_detect_output(void) {
     return OUTPUT_NONE;
 }
 
+/** \brief Where To Send
+ *
+ * FIXME: Needs doc
+ */
 uint8_t where_to_send(void) {
     if (desired_output == OUTPUT_AUTO) {
         return auto_detect_output();