sbin/res/app/lib/JSDOC.js
author hamidouk
Fri, 23 Dec 2011 10:59:23 +0100
branchjsdoc
changeset 519 46e21d060650
permissions -rw-r--r--
added jsdoc base files.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
519
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
     1
/**
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
     2
	@overview
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
     3
	@date $Date: 2010-06-13 22:02:44 +0100 (Sun, 13 Jun 2010) $
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
     4
	@version $Revision: 837 $ 
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
     5
	@location $HeadURL: https://jsdoc-toolkit.googlecode.com/svn/tags/jsdoc_toolkit-2.4.0/jsdoc-toolkit/app/lib/JSDOC.js $
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
     6
	@name JSDOC.js
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
     7
 */
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
     8
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
     9
/**
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    10
	This is the main container for the JSDOC application.
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    11
	@namespace
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    12
*/
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    13
JSDOC = {
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    14
};
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    15
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    16
/**
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    17
	@requires Opt
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    18
 */
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    19
if (typeof arguments == "undefined") arguments = [];
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    20
JSDOC.opt = Opt.get(
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    21
	arguments, 
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    22
	{
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    23
		a: "allfunctions", 
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    24
		c: "conf",
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    25
		d: "directory",
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    26
		"D[]": "define",
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    27
		e: "encoding",
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    28
		"E[]": "exclude",
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    29
		h: "help",
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    30
		m: "multiple",
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    31
		n: "nocode",
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    32
		o: "out",
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    33
		p: "private",
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    34
		q: "quiet",
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    35
		r: "recurse",
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    36
		S: "securemodules",
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    37
		s: "suppress",
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    38
		t: "template",
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    39
		T: "testmode",
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    40
		u: "unique",
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    41
		v: "verbose",
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    42
		x: "ext"
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    43
	}
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    44
);
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    45
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    46
/** The current version string of this application. */
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    47
JSDOC.VERSION = "2.4.0";
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    48
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    49
/** Print out usage information and quit. */
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    50
JSDOC.usage = function() {
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    51
	print("USAGE: java -jar jsrun.jar app/run.js [OPTIONS] <SRC_DIR> <SRC_FILE> ...");
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    52
	print("");
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    53
	print("OPTIONS:");
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    54
	print("  -a or --allfunctions\n          Include all functions, even undocumented ones.\n");
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    55
	print("  -c or --conf\n          Load a configuration file.\n");
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    56
	print("  -d=<PATH> or --directory=<PATH>\n          Output to this directory (defaults to \"out\").\n");
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    57
	print("  -D=\"myVar:My value\" or --define=\"myVar:My value\"\n          Multiple. Define a variable, available in JsDoc as JSDOC.opt.D.myVar.\n");
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    58
	print("  -e=<ENCODING> or --encoding=<ENCODING>\n          Use this encoding to read and write files.\n");
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    59
	print("  -E=\"REGEX\" or --exclude=\"REGEX\"\n          Multiple. Exclude files based on the supplied regex.\n");
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    60
	print("  -h or --help\n          Show this message and exit.\n");
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    61
	print("  -m or --multiples\n          Don't warn about symbols being documented more than once.\n");
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    62
	print("  -n or --nocode\n          Ignore all code, only document comments with @name tags.\n");
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    63
	print("  -o=<PATH> or --out=<PATH>\n          Print log messages to a file (defaults to stdout).\n");
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    64
	print("  -p or --private\n          Include symbols tagged as private, underscored and inner symbols.\n");
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    65
	print("  -q or --quiet\n          Do not output any messages, not even warnings.\n");
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    66
	print("  -r=<DEPTH> or --recurse=<DEPTH>\n          Descend into src directories.\n");
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    67
	print("  -s or --suppress\n          Suppress source code output.\n");
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    68
	print("  -S or --securemodules\n          Use Secure Modules mode to parse source code.\n");
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    69
	print("  -t=<PATH> or --template=<PATH>\n          Required. Use this template to format the output.\n");
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    70
	print("  -T or --test\n          Run all unit tests and exit.\n");
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    71
	print("  -u or --unique\n          Force file names to be unique, but not based on symbol names.\n");
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    72
	print("  -v or --verbose\n          Provide verbose feedback about what is happening.\n");
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    73
	print("  -x=<EXT>[,EXT]... or --ext=<EXT>[,EXT]...\n          Scan source files with the given extension/s (defaults to js).\n");
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    74
	
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    75
	quit();
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    76
}
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    77
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    78
/*t:
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    79
	plan(4, "Testing JSDOC namespace.");
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    80
	
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    81
	is(
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    82
		typeof JSDOC,
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    83
		"object",
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    84
		"JSDOC.usage is a function."
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    85
	);
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    86
	
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    87
	is(
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    88
		typeof JSDOC.VERSION,
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    89
		"string",
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    90
		"JSDOC.VERSION is a string."
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    91
	);
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    92
	
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    93
	is(
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    94
		typeof JSDOC.usage,
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    95
		"function",
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    96
		"JSDOC.usage is a function."
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    97
	);
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    98
	
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
    99
	is(
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
   100
		typeof JSDOC.opt,
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
   101
		"object",
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
   102
		"JSDOC.opt is a object."
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
   103
	);
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
   104
 */
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
   105
46e21d060650 added jsdoc base files.
hamidouk
parents:
diff changeset
   106
if (this.IO) IO.includeDir("lib/JSDOC/");