Package org.apache.maven.plugin.plugin
Class DescriptorGeneratorMojo
java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.plugin.plugin.AbstractGeneratorMojo
org.apache.maven.plugin.plugin.DescriptorGeneratorMojo
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled
,org.apache.maven.plugin.Mojo
@Mojo(name="descriptor",
defaultPhase=PROCESS_CLASSES,
requiresDependencyResolution=COMPILE_PLUS_RUNTIME,
threadSafe=true)
public class DescriptorGeneratorMojo
extends AbstractGeneratorMojo
Generate a plugin descriptor.
Note: Since 3.0, for Java plugin annotations support, default phase defined by this goal is after the "compilation" of any scripts. This doesn't override the default binding coded at generate-resources phase in Maven core.
- Since:
- 2.0
- Author:
- Jason van Zyl
-
Field Summary
Modifier and TypeFieldDescriptionprotected org.sonatype.plexus.build.incremental.BuildContext
Creates links to existing external javadoc-generated documentation.protected URI
The base URL for the Javadoc site containing the current project's API documentation.protected String
The version of the javadoc tool (equal to the container JDK version) used to generate the internal javadoc Only relevant ifinternalJavadocBaseUrl
is set.Fields inherited from class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
goalPrefix, LS, project
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
-
Constructor Summary
-
Method Summary
Methods inherited from class org.apache.maven.plugin.plugin.AbstractGeneratorMojo
execute
Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
-
Field Details
-
externalJavadocBaseUrls
@Parameter(property="externalJavadocBaseUrls", alias="links") protected List<URI> externalJavadocBaseUrlsCreates links to existing external javadoc-generated documentation.
Notes: all given links should have a fetchable/package-list
or/element-list
file. For instance:<links> <link>https://docs.oracle.com/javase/8/docs/api/</link> <links>
is valid becausehttps://docs.oracle.com/javase/8/docs/api/package-list
exists. See link option of the javadoc tool. Using this parameter requires connectivity to the given URLs during the goal execution.- Since:
- 3.7.0
-
internalJavadocBaseUrl
The base URL for the Javadoc site containing the current project's API documentation. This may be relative to the root of the generated Maven site. It does not need to exist yet at the time when this goal is executed. Must end with a slash. In case this is set the javadoc reporting goal should be executed prior to Plugin Report.- Since:
- 3.7.0
-
internalJavadocVersion
@Parameter(property="internalJavadocVersion", defaultValue="${java.version}") protected String internalJavadocVersionThe version of the javadoc tool (equal to the container JDK version) used to generate the internal javadoc Only relevant ifinternalJavadocBaseUrl
is set. The default value needs to be overwritten in case toolchains are being used for generating Javadoc.- Since:
- 3.7.0
-
buildContext
-
-
Constructor Details
-
DescriptorGeneratorMojo
public DescriptorGeneratorMojo()
-
-
Method Details
-
generate
- Specified by:
generate
in classAbstractGeneratorMojo
- Throws:
org.apache.maven.plugin.MojoExecutionException
-