Package poussecafe.maven

Class GenerateDocMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

poussecafe.maven.GenerateDocMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="generate-doc",
      requiresDependencyResolution=COMPILE_PLUS_RUNTIME,
      requiresDependencyCollection=COMPILE_PLUS_RUNTIME)
public class GenerateDocMojo
extends org.apache.maven.plugin.AbstractMojo

Generates an expert-readable documentation of the Model. The documentation is generated in HTML and as a PDF file.

Documentation is generated by analyzing source code. Further instructions about how to enable documentation generation can be found here.

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
GenerateDocMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GenerateDocMojo

public GenerateDocMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException