scripts/jsdoctoolkit.sh
author Daniel Hans <Daniel.M.Hans@gmail.com>
Tue, 03 Nov 2009 00:50:23 +0100
changeset 3075 1e78db95e38a
parent 3042 72eec4d72471
permissions -rwxr-xr-x
getListContentForData function added to lists helper. It allows to manually set a list of entities which is to be displayed on the view. Previously, the only function was getListContent, but it retrived data on its own by a single query. The new function can be useful whenever it is impossible or very awkward to obtain entities in such a way (for example more sophisticated SQL statements). Additionally, the getListContent function is reconstructed so that it collects the data first and then calls getListContentForData.

#!/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 ***"