/trunk/jsdoc-toolkit/conf/sample.conf

 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 jsrun.jar app/run.js -c=conf/sample.conf
10
11*/
12
13{
14	// source files to use
15	_: ['app/test/jsdoc_test.js'],
16	
17	// document all functions, even uncommented ones
18	a: true,
19	
20	// including those marked @private
21	p: true,
22	
23	// some extra variables I want to include
24	D: {generatedBy: "Michael Mathews", copyright: "2008"},
25	
26	// use this directory as the output directory
27	d: "docs",
28	
29	// use this template
30	t: "templates/jsdoc"
31}