|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.maven.tools.plugin.generator.PluginXdocGenerator
public class PluginXdocGenerator
Generate xdoc documentation for each mojo.
Constructor Summary | |
---|---|
PluginXdocGenerator()
Default constructor using Locale.ENGLISH as locale. |
|
PluginXdocGenerator(MavenProject project)
Constructor using Locale.ENGLISH as locale. |
|
PluginXdocGenerator(MavenProject project,
Locale locale)
|
Method Summary | |
---|---|
void |
execute(File destinationDirectory,
PluginToolsRequest request)
Execute the generation for a given plugin descriptor. |
protected void |
processMojoDescriptor(MojoDescriptor mojoDescriptor,
File destinationDirectory)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PluginXdocGenerator()
Locale.ENGLISH
as locale.
Used only in test cases.
public PluginXdocGenerator(MavenProject project)
Locale.ENGLISH
as locale.
project
- not null Maven project.public PluginXdocGenerator(MavenProject project, Locale locale)
project
- not null.locale
- not null wanted locale.Method Detail |
---|
public void execute(File destinationDirectory, PluginToolsRequest request) throws GeneratorException
execute
in interface Generator
destinationDirectory
- requiredrequest
- required
GeneratorException
protected void processMojoDescriptor(MojoDescriptor mojoDescriptor, File destinationDirectory) throws IOException
mojoDescriptor
- not nulldestinationDirectory
- not null
IOException
- if any
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |