scripts/jsdoctoolkit.sh
author Mario Ferraro <fadinlight@gmail.com>
Sun, 25 Oct 2009 19:21:43 +0000
changeset 3042 72eec4d72471
permissions -rwxr-xr-x
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.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
3042
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
     1
#!/bin/bash
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
     2
#Requires java installed
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
     3
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
     4
jsdoc_dir="../thirdparty/jsdoctoolkit"
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
     5
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
     6
js_dir="../app/soc/content/js"
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
     7
doc_dir="$js_dir/documentation"
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
     8
private_doc_dir="$doc_dir/private"
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
     9
public_doc_dir="$doc_dir/public"
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
    10
private_all_doc_dir="$doc_dir/private_all"
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
    11
public_all_doc_dir="$doc_dir/public_all"
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
    12
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
    13
echo "*** JSDOCTOOLKIT: cleaning out former documentation dir ***"
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
    14
rm -fr $doc_dir
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
    15
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
    16
echo "*** JSDOCTOOLKIT: creating private documentation ***"
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
    17
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
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
    18
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
    19
echo "*** JSDOCTOOLKIT: creating private documentation for all functions ***"
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
    20
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
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
    21
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
    22
echo "*** JSDOCTOOLKIT: creating public documentation ***"
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
    23
java -jar $jsdoc_dir/jsrun.jar $jsdoc_dir/app/run.js $js_dir/*.js -r -t=$jsdoc_dir/templates/jsdoc -d=$public_doc_dir
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
    24
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
    25
echo "*** JSDOCTOOLKIT: creating public documentation for all functions ***"
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
    26
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
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
    27
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
    28
echo "*** JSDOCTOOLKIT: processing finished, documentation available in app/soc/content/js/documentation ***"
72eec4d72471 Script to run JSDocToolkit over our JS files.
Mario Ferraro <fadinlight@gmail.com>
parents:
diff changeset
    29