docck:check

Full name:

org.apache.maven.plugins:maven-docck-plugin:1.0:check

Description:

Checks a plugin's documentation for the standard minimums.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Executes as an aggregator plugin.
  • Binds by default to the lifecycle phase: validate.

Optional Parameters

Name Type Since Description
offline boolean - Sets whether this plugin is running in offline or online mode. Also useful when you don't want to verify http URLs.
output File - An optional location where the results will be written to. If this is not specified the results will be written to the console.
siteDirectory String - Directory where the site source for the project is located.
Default value is: src/site.

Parameter Details

offline:

Sets whether this plugin is running in offline or online mode. Also useful when you don't want to verify http URLs.
  • Type: boolean
  • Required: No
  • Expression: ${settings.offline}

output:

An optional location where the results will be written to. If this is not specified the results will be written to the console.
  • Type: java.io.File
  • Required: No
  • Expression: ${output}

siteDirectory:

Directory where the site source for the project is located.
  • Type: java.lang.String
  • Required: No
  • Expression: ${siteDirectory}
  • Default: src/site