PageRenderTime 20ms CodeModel.GetById 14ms app.highlight 2ms RepoModel.GetById 1ms app.codeStats 0ms

/branches/version1.x/examples/sample.conf

http://jsdoc-toolkit.googlecode.com/
Unknown | 32 lines | 24 code | 8 blank | 0 comment | 0 complexity | dc2d31cd31e0e81d38b787ca9e7c016a MD5 | raw file
 1/*
 2	This is an example of one way you could set up a configuration file to more
 3	conveniently define some commandline options. You might like to do this if
 4	you frequently reuse the same options. Note that you don't need to define
 5	every option in this file, you can combine a configuration file with
 6	additional options on the commandline if your wish.
 7	
 8	You would include this configuration file by running JsDoc Toolkit like so:
 9	java -jar app/js.jar app/run.js -c=examples/sample.conf
10	
11	This would be equivalent to the following:
12	java -jar app/js.jar app/run.js -a -D="generatedBy:Michael Mathews" -D="copyright:2007" -d=docs -t=templates/sweet app/
13
14	See http://code.google.com/p/jsdoc-toolkit/wiki/CmdlineOptions for more.
15*/
16
17{
18	// source files to use
19	_: ['app/'],
20	
21	// document all functions, even uncommented ones
22	a: true,
23	
24	// some extra variables I want to include
25	D: {generatedBy: "Michael Mathews", copyright: "2007"},
26	
27	// use this directory as the output directory
28	d: "docs",
29	
30	// use this template
31	t: "templates/sweet"
32}