diff --git a/jsdoc b/jsdoc index b0edabcf..dd161e05 100755 --- a/jsdoc +++ b/jsdoc @@ -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 diff --git a/templates/haruki/README.md b/templates/haruki/README.md index 4a8e5cf1..db5ce462 100644 --- a/templates/haruki/README.md +++ b/templates/haruki/README.md @@ -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 \ No newline at end of file + ./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. \ No newline at end of file