# HG changeset patch
# User Mario Ferraro <fadinlight@gmail.com>
# Date 1256498503 0
# Node ID 72eec4d724711b576eb5ca9cbe9b2331f9432271
# Parent  c8f47f0b6697118ee8df554903a5dd3192f86b8d
Script to run JSDocToolkit over our JS files.

It creates a documentation directory under app/soc/content/js
with the output for private and public docs, with or without
undocumented functions.

diff -r c8f47f0b6697 -r 72eec4d72471 scripts/jsdoctoolkit.sh
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/scripts/jsdoctoolkit.sh	Sun Oct 25 19:21:43 2009 +0000
@@ -0,0 +1,29 @@
+#!/bin/bash
+#Requires java installed
+
+jsdoc_dir="../thirdparty/jsdoctoolkit"
+
+js_dir="../app/soc/content/js"
+doc_dir="$js_dir/documentation"
+private_doc_dir="$doc_dir/private"
+public_doc_dir="$doc_dir/public"
+private_all_doc_dir="$doc_dir/private_all"
+public_all_doc_dir="$doc_dir/public_all"
+
+echo "*** JSDOCTOOLKIT: cleaning out former documentation dir ***"
+rm -fr $doc_dir
+
+echo "*** JSDOCTOOLKIT: creating private documentation ***"
+java -jar $jsdoc_dir/jsrun.jar $jsdoc_dir/app/run.js $js_dir/*.js -r -p -t=$jsdoc_dir/templates/jsdoc -d=$private_doc_dir
+
+echo "*** JSDOCTOOLKIT: creating private documentation for all functions ***"
+java -jar $jsdoc_dir/jsrun.jar $jsdoc_dir/app/run.js $js_dir/*.js -r -a -p -t=$jsdoc_dir/templates/jsdoc -d=$private_all_doc_dir
+
+echo "*** JSDOCTOOLKIT: creating public documentation ***"
+java -jar $jsdoc_dir/jsrun.jar $jsdoc_dir/app/run.js $js_dir/*.js -r -t=$jsdoc_dir/templates/jsdoc -d=$public_doc_dir
+
+echo "*** JSDOCTOOLKIT: creating public documentation for all functions ***"
+java -jar $jsdoc_dir/jsrun.jar $jsdoc_dir/app/run.js $js_dir/*.js -r -a -t=$jsdoc_dir/templates/jsdoc -d=$public_all_doc_dir
+
+echo "*** JSDOCTOOLKIT: processing finished, documentation available in app/soc/content/js/documentation ***"
+