jstools:jsdoc

Goal to generate JavaScript documentation using the JSDoc Toolkit

Mojo Attributes :

  • Requires a Maven 2.0 project to execute.

Required Parameters

Name Type Description
baseDir File Maven Internal : The base directory. Default is ${basedir}
buildDir String Maven Internal : The build directory. Default is ${project.build.directory}

Optional Parameters

Name Type Description
caseSensitive boolean Whether the file selection patterns should be case sensitive. Default is true.
excludes String The excluded files pattern. Default is empty.
helper MavenProjectHelper Maven Internal : A Project Helper instance.
includePrivate boolean Whether to include symbols tagged as private. Default is false.
includeUndocumented boolean Include all functions, even undocumented ones. Default is false.
includeUndocumentedUnderscored boolean Include all functions, even undocumented, underscored ones. Default is false.
includes String The include pattern used to select javascript files for processing. Default is all (recursive) files with a .js extention
jArgument boolean Use the -j option, must be set to false for JSDoc Toolkit 1.x. or true for JSDoc Toolkit version 2.0 and above. Default is true.
jsDir String The path to the JavaScript source directory (appended to ${basedir}). Default is src/main/js
jsdocHome String A path pointing to a the desired JSDoc Toolkit directory (e.g. /home/username/stuff/jsdoc_toolkit-1.3.0). If no value is provided the plugin wil use its own internal version.
outputBaseDirectory String The output directory.
siteRenderer SiteRenderer Maven Internal : The Doxia Site Renderer.
template String The JSDoc template to use. Valid values are template directory names in the JSDoc Toolkit Distribution used or paths to an appropriate template directory. The default is JSDocs' "jsdoc" template.

Parameter Details

baseDir

Maven Internal : The base directory. Default is ${basedir}

  • Type : java.io.File
  • Required : Yes
  • Expression : ${basedir}

buildDir

Maven Internal : The build directory. Default is ${project.build.directory}

  • Type : java.lang.String
  • Required : Yes
  • Expression : ${project.build.directory}

caseSensitive

Whether the file selection patterns should be case sensitive. Default is true.

  • Type : boolean
  • Required : No
  • Expression : true

excludes

The excluded files pattern. Default is empty.

  • Type : java.lang.String
  • Required : No

helper

Maven Internal : A Project Helper instance.

  • Type : org.apache.maven.project.MavenProjectHelper
  • Required : No

includePrivate

Whether to include symbols tagged as private. Default is false.

  • Type : boolean
  • Required : No
  • Expression : false

includeUndocumented

Include all functions, even undocumented ones. Default is false.

  • Type : boolean
  • Required : No
  • Expression : false

includeUndocumentedUnderscored

Include all functions, even undocumented, underscored ones. Default is false.

  • Type : boolean
  • Required : No
  • Expression : false

includes

The include pattern used to select javascript files for processing. Default is all (recursive) files with a .js extention

  • Type : java.lang.String
  • Required : No

jArgument

Use the -j option, must be set to false for JSDoc Toolkit 1.x. or true for JSDoc Toolkit version 2.0 and above. Default is true.

  • Type : boolean
  • Required : No
  • Expression : true

jsDir

The path to the JavaScript source directory (appended to ${basedir}). Default is src/main/js

  • Type : java.lang.String
  • Required : No
  • Expression : src/main/js

jsdocHome

A path pointing to a the desired JSDoc Toolkit directory (e.g. /home/username/stuff/jsdoc_toolkit-1.3.0). If no value is provided the plugin wil use its own internal version.

  • Type : java.lang.String
  • Required : No

outputBaseDirectory

The output directory.

  • Type : java.lang.String
  • Required : No
  • Expression : ${project.build.directory}/site/

siteRenderer

Maven Internal : The Doxia Site Renderer.

  • Type : org.codehaus.doxia.site.renderer.SiteRenderer
  • Required : No

template

The JSDoc template to use. Valid values are template directory names in the JSDoc Toolkit Distribution used or paths to an appropriate template directory. The default is JSDocs' "jsdoc" template.

  • Type : java.lang.String
  • Required : No
  • Expression : jsdoc