From 7c9d5ace143d3cc6d767a354acde814926d566fd Mon Sep 17 00:00:00 2001
From: skullydazed <skullydazed@users.noreply.github.com>
Date: Wed, 21 Mar 2018 23:50:38 -0700
Subject: 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
---
 util/travis_docs.sh | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 util/travis_docs.sh

(limited to 'util/travis_docs.sh')

diff --git a/util/travis_docs.sh b/util/travis_docs.sh
new file mode 100644
index 000000000..ec553952c
--- /dev/null
+++ b/util/travis_docs.sh
@@ -0,0 +1,14 @@
+#!/bin/bash
+
+source util/travis_push.sh
+
+if [[ "$TRAVIS_COMMIT_MESSAGE" != *"[skip docs]"* ]] ; then 
+	if git diff --name-only ${TRAVIS_COMMIT_RANGE} | grep -e '^quantum/' -e '^tmk_core/' -e '^docs/api_.*'; then
+		echo "Generating API docs..."
+		rm -rf doxygen
+		doxygen Doxyfile
+		moxygen -a -g -o -q docs/api_%s.md doxygen/xml
+		git add docs/api_*
+		git commit -m'autogenerated api docs for ${TRAVIS_COMMIT_RANGE}' || true
+	fi
+fi
-- 
cgit v1.2.3-24-g4f1b