archive-gh-me/jsdoc
1
0
Fork 0
mirror of https://github.com/jsdoc/jsdoc.git synced 2025-12-08 19:46:11 +00:00
Code Issues Projects Releases Wiki Activity

Running in normal mode should be quiet to allow results to be piped in to other processes.

Browse Source
This commit is contained in:
Michael Mathews 2012-05-29 16:34:18 +01:00
parent 6580e17629
commit 84f4e54c55
2 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
jsdoc
View File

@ -7,6 +7,7 @@ BASEDIR="$( cd -P "$( dirname "$SOURCE" )" && pwd )"
if test $1 = "--debug"
then
echo "Running Debug"
CMD="org.mozilla.javascript.tools.debugger.Main -debug"
shift
else
@ -19,7 +20,7 @@ then
echo "Running Tests"
java -classpath ${BASEDIR}/lib/js.jar ${CMD} -opt -1 -modules ${BASEDIR}/node_modules -modules ${BASEDIR}/rhino_modules -modules ${BASEDIR} ${BASEDIR}/jsdoc.js --dirname=${BASEDIR} $@
else
echo "Running Normal"
# normal mode should be quiet
java -classpath ${BASEDIR}/lib/js.jar ${CMD} -modules ${BASEDIR}/node_modules -modules ${BASEDIR}/rhino_modules -modules ${BASEDIR} ${BASEDIR}/jsdoc.js --dirname=${BASEDIR} $@
fi

7
templates/haruki/README.md
View File

@ -18,9 +18,12 @@ Currently Haruki only supports a subset of the tags supported by the default tem
* @throws
* @example
* @access (like @private or @public)
Note: `@link`s will appear in the output untransformed, there is no way to know at this stage what the file layout of your output will eventually be. It is assumed that whatever process emits the final output file/s will transform `@link` tags at that point.
USAGE
=====
./jsdoc myscript.js -t templates/haruki -d console -q format=xml
./jsdoc myscript.js -t templates/haruki -d console -q format=xml
The results of this command will appear in `stdout` and can be piped into other tools for further processing.