docck:check

Full name:

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

Description:

Checks a plugin's documentation for the standard minimums.

Attributes:

  • Requires a Maven 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.
User property is: settings.offline.
<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.
User property is: output.
<siteDirectory> String - Directory where the site source for the project is located.
Default value is: src/site.
User property is: siteDirectory.

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
  • User Property: 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
  • User Property: output

<siteDirectory>

Directory where the site source for the project is located.
  • Type: java.lang.String
  • Required: No
  • User Property: siteDirectory
  • Default: src/site