Class PluginXdocGenerator
- java.lang.Object
-
- org.apache.maven.tools.plugin.generator.PluginXdocGenerator
-
- All Implemented Interfaces:
Generator
public class PluginXdocGenerator extends java.lang.Object implements Generator
Generate xdoc documentation for each mojo.
-
-
Constructor Summary
Constructors Constructor Description PluginXdocGenerator()
Default constructor usingLocale.ENGLISH
as locale.PluginXdocGenerator(org.apache.maven.project.MavenProject project)
Constructor usingLocale.ENGLISH
as locale.PluginXdocGenerator(org.apache.maven.project.MavenProject project, java.util.Locale locale, java.io.File reportOutputDirectory, boolean disableInternalJavadocLinkValidation)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
execute(java.io.File destinationDirectory, org.apache.maven.tools.plugin.PluginToolsRequest request)
Execute the generation for a given plugin descriptor.protected void
processMojoDescriptor(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor, java.io.File destinationDirectory)
-
-
-
Constructor Detail
-
PluginXdocGenerator
public PluginXdocGenerator()
Default constructor usingLocale.ENGLISH
as locale. Used only in test cases.
-
PluginXdocGenerator
public PluginXdocGenerator(org.apache.maven.project.MavenProject project)
Constructor usingLocale.ENGLISH
as locale.- Parameters:
project
- not null Maven project.
-
PluginXdocGenerator
public PluginXdocGenerator(org.apache.maven.project.MavenProject project, java.util.Locale locale, java.io.File reportOutputDirectory, boolean disableInternalJavadocLinkValidation)
- Parameters:
project
- not null.locale
- not null.
-
-
Method Detail
-
execute
public void execute(java.io.File destinationDirectory, org.apache.maven.tools.plugin.PluginToolsRequest request) throws GeneratorException
Execute the generation for a given plugin descriptor.- Specified by:
execute
in interfaceGenerator
- Parameters:
destinationDirectory
- requiredrequest
- required- Throws:
GeneratorException
- if any
-
processMojoDescriptor
protected void processMojoDescriptor(org.apache.maven.plugin.descriptor.MojoDescriptor mojoDescriptor, java.io.File destinationDirectory) throws java.io.IOException
- Parameters:
mojoDescriptor
- not nulldestinationDirectory
- not null- Throws:
java.io.IOException
- if any
-
-