Merge pull request #565 from danvk/gulp

[dygraphs.git] / scripts / generate-jsdoc.sh

diff --git a/scripts/generate-jsdoc.sh b/scripts/generate-jsdoc.sh
new file mode 100755 (executable)
index 0000000..6512fb0
--- /dev/null
+++ b/scripts/generate-jsdoc.sh
@@ -0,0 +1,19 @@
+#!/bin/bash
+#
+# Generates JSDoc in the /jsdoc dir. Clears any existing jsdoc there.
+
+rm -rf jsdoc
+echo Generating JSDoc...
+java -jar jsdoc-toolkit/jsrun.jar \
+  jsdoc-toolkit/app/run.js \
+  -d=jsdoc -t=jsdoc-toolkit/templates/jsdoc \
+  dygraph.js \
+| tee /tmp/dygraphs-jsdocerrors.txt
+
+if [ -s /tmp/dygraphs-jsdocerrors.txt ]; then
+  echo Please fix any jsdoc errors/warnings before sending patches.
+fi
+
+chmod -R a+rX jsdoc
+
+echo Done