javascript-report:jsdoc

Note:This goal should be used as a Maven report.

Full name:

org.codehaus.mojo.javascript:javascript-report-maven-plugin:1.1-softec:jsdoc

Description:

Generate JsDoc report

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: site.

Optional Parameters

Name Type Since Description
customTemplate File - JsDoc custom template to be used (overrides template)
encoding String - Source code encoding
includePrivate boolean - Include symbols tagged as private ?
includeUnderscore boolean - Include all functions, even undocumented, underscored ones ?
includeUndocumented boolean - Include all functions, even undocumented ones ?
recurse int - By default this will collect all source files to a depth of 10 folders deep, but you can specify your preferred depth
Default value is: 10.
sourceDirectory File - Location of the source files.
Default value is: ${basedir}/src/main/javascript.
template String - JsDoc template to be used
Default value is: sunny.
workDirectory File - The jsdoc working directory
Default value is: ${project.build.directory}.

Parameter Details

customTemplate:

JsDoc custom template to be used (overrides template)
  • Type: java.io.File
  • Required: No

encoding:

Source code encoding
  • Type: java.lang.String
  • Required: No

includePrivate:

Include symbols tagged as private ?
  • Type: boolean
  • Required: No

includeUnderscore:

Include all functions, even undocumented, underscored ones ?
  • Type: boolean
  • Required: No

includeUndocumented:

Include all functions, even undocumented ones ?
  • Type: boolean
  • Required: No

recurse:

By default this will collect all source files to a depth of 10 folders deep, but you can specify your preferred depth
  • Type: int
  • Required: No
  • Default: 10

sourceDirectory:

Location of the source files.
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/src/main/javascript

template:

JsDoc template to be used
  • Type: java.lang.String
  • Required: No
  • Default: sunny

workDirectory:

The jsdoc working directory
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}