#summary Advanced Configuration Options

||Navigation>>||  [Manual Start]  ||  [TagReference Next - Tag Reference] || [AdvancedFunction Previous - Documenting Functions] ||

------


= Advanced Configuration Options ==
As mentioned [InstallAndSetup above], jGrouseDoc uses the file jgrousedoc.properties for configuration purposes.

The possible parameters in this file are:
|| *Parameter* || *Default value* || *Description* ||
|| jGrouseHome.default || must be overridden || Directory with jGrouseDoc binaries ||
|| inputDir.default || must be overridden || Directory with source files ||
|| fileMask.default || `**/*.js` || File mask for source files. Default setting includes all `*.js` files ||
|| outputDir.default || `api` || Directory for output files. *Must be different from the source directory.* This directory is re-created for each run.||
|| skin || `noframes` || Select skin - options are *`classic`*, *`modern`* and *`noframes`*. Skin is an alternate method of rendering documentation ||
|| theme || sample || Theme is an alternate set of stylesheets and related resources, which could be applied to certain skins. Standard themes are *`sample`* and *`simple`*. The `simple` theme follows standard JavaDoc look while `sample` has fancy color scheme. See [CustomizationGuide Customization Guide] for more information about themes.||
|| aux_css || optional || Use `aux_css` parameter to specify the css file that should be used along with jgdoc.css. Note - the name should be relative to the output directory. See more in [CustomizationGuide Customization Guide] ||
|| privatePrefix || `_` || When privatePrefix is specified, functions, variables, classes, etc with names starting with the prefix ||
|| srcUrl || no default || URL template for "view source" link, like `http://jgrousedoc.googlecode.com/svn/trunk/sample/${jg_filePath}#${jg_lineNum}`. In the URL template the placeholders ${jg_filePath} and ${jg_lineNum} denote positions where file name and line number would be inserted ||
|| outputFormat || `bin` || Selects rendering engine. Possible values are *`bin`* - chooses renderer based on Velocity templates (fast, but `classic` skin is not supported yet) and *`xml`* - chooses renderer based on XSLT transformation (slower than Velocity, but supports all three themes)||
||encoding || UTF-8 || encoding of the XML project file produced when *`XML'* output format is specified ||
||srcEncoding || system default || Set encoding of source files ||
|| suppressGlobalWarnings || `false` || Whether warnings about implicit use of GLOBAL namespace should be suppressed. Possible values are *`true`* and *`false`* ||
|| useFullNames || `true` || Indicator whether the modern renderer should be using fully qualified element names when rendering the 'browse by name' frame ||
|| projectName || optional || Set short name of your project, see also [TagProject @project] tag ||
|| appVersion || optional || Set version of your product, see also [TagProject @project] tag ||
|| projectDesc || optional || Set the description of your project - it would appear on startup page, see also [TagProject @project] tag ||
|| projectFile || jgrouse.jgd || Name of a file that is produced by jGrouseDoc parser - contains internal representation of extracted comments||
|| jgdoc.defaultView || navtree.html || Default view for *`modern`* theme ||
|| stopOnErrors || `false` || Whether the tool should stop whenever it finds an error or if it should treat errors as warnings. Possible values are *`true`* and *`false`* ||


---------


||Navigation>>||  [Manual Start]  ||  [TagReference Next - Tag Reference] || [AdvancedFunction Previous - Documenting Functions] ||