/tags/jsdoc_toolkit-2.3.2/jsdoc-toolkit/app/lib/JSDOC.js
http://jsdoc-toolkit.googlecode.com/ · JavaScript · 104 lines · 54 code · 7 blank · 43 comment · 3 complexity · aeddf99cbeca93eb734218a5dd3aa4dd MD5 · raw file
- /**
- @overview
- @date $Date: 2009-09-04 08:43:41 +0200 (Fri, 04 Sep 2009) $
- @version $Revision: 814 $
- @location $HeadURL: http://jsdoc-toolkit.googlecode.com/svn/tags/jsdoc_toolkit-2.3.2/jsdoc-toolkit/app/lib/JSDOC.js $
- @name JSDOC.js
- */
- /**
- This is the main container for the JSDOC application.
- @namespace
- */
- JSDOC = {
- };
- /**
- @requires Opt
- */
- if (typeof arguments == "undefined") arguments = [];
- JSDOC.opt = Opt.get(
- arguments,
- {
- a: "allfunctions",
- c: "conf",
- d: "directory",
- "D[]": "define",
- e: "encoding",
- "E[]": "exclude",
- h: "help",
- n: "nocode",
- o: "out",
- p: "private",
- q: "quiet",
- r: "recurse",
- S: "securemodules",
- s: "suppress",
- t: "template",
- T: "testmode",
- u: "unique",
- v: "verbose",
- x: "ext"
- }
- );
- /** The current version string of this application. */
- JSDOC.VERSION = "2.3.2";
- /** Print out usage information and quit. */
- JSDOC.usage = function() {
- print("USAGE: java -jar jsrun.jar app/run.js [OPTIONS] <SRC_DIR> <SRC_FILE> ...");
- print("");
- print("OPTIONS:");
- print(" -a or --allfunctions\n Include all functions, even undocumented ones.\n");
- print(" -c or --conf\n Load a configuration file.\n");
- print(" -d=<PATH> or --directory=<PATH>\n Output to this directory (defaults to \"out\").\n");
- print(" -D=\"myVar:My value\" or --define=\"myVar:My value\"\n Multiple. Define a variable, available in JsDoc as JSDOC.opt.D.myVar.\n");
- print(" -e=<ENCODING> or --encoding=<ENCODING>\n Use this encoding to read and write files.\n");
- print(" -E=\"REGEX\" or --exclude=\"REGEX\"\n Multiple. Exclude files based on the supplied regex.\n");
- print(" -h or --help\n Show this message and exit.\n");
- print(" -n or --nocode\n Ignore all code, only document comments with @name tags.\n");
- print(" -o=<PATH> or --out=<PATH>\n Print log messages to a file (defaults to stdout).\n");
- print(" -p or --private\n Include symbols tagged as private, underscored and inner symbols.\n");
- print(" -q or --quiet\n Do not output any messages, not even warnings.\n");
- print(" -r=<DEPTH> or --recurse=<DEPTH>\n Descend into src directories.\n");
- print(" -s or --suppress\n Suppress source code output.\n");
- print(" -S or --securemodules\n Use Secure Modules mode to parse source code.\n");
- print(" -t=<PATH> or --template=<PATH>\n Required. Use this template to format the output.\n");
- print(" -T or --test\n Run all unit tests and exit.\n");
- print(" -u or --unique\n Force file names to be unique, but not based on symbol names.\n");
- print(" -v or --verbose\n Provide verbose feedback about what is happening.\n");
- print(" -x=<EXT>[,EXT]... or --ext=<EXT>[,EXT]...\n Scan source files with the given extension/s (defaults to js).\n");
-
- quit();
- }
- /*t:
- plan(4, "Testing JSDOC namespace.");
-
- is(
- typeof JSDOC,
- "object",
- "JSDOC.usage is a function."
- );
-
- is(
- typeof JSDOC.VERSION,
- "string",
- "JSDOC.VERSION is a string."
- );
-
- is(
- typeof JSDOC.usage,
- "function",
- "JSDOC.usage is a function."
- );
-
- is(
- typeof JSDOC.opt,
- "object",
- "JSDOC.opt is a object."
- );
- */
- if (this.IO) IO.includeDir("lib/JSDOC/");