com.webcohesion.enunciate.mojo

Class DocsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.webcohesion.enunciate.mojo.ConfigMojo

com.webcohesion.enunciate.mojo.DocsBaseMojo

com.webcohesion.enunciate.mojo.DocsMojo

All Implemented Interfaces:

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

@Mojo(name="docs",
      defaultPhase=PROCESS_SOURCES,
      requiresDependencyResolution=COMPILE_PLUS_RUNTIME)
public class DocsMojo
extends DocsBaseMojo

Generates the Enunciate documentation, including any client-side libraries.

Author:

Ryan Heaton

Nested Class Summary

Nested classes/interfaces inherited from class com.webcohesion.enunciate.mojo.ConfigMojo

ConfigMojo.MavenEnunciateLogger

Field Summary

Fields inherited from class com.webcohesion.enunciate.mojo.DocsBaseMojo

docsDir, docsStagingDir, docsSubdir, indexPageName, reportDescription, reportName

Fields inherited from class com.webcohesion.enunciate.mojo.ConfigMojo

artifactFactory, artifactResolver, artifacts, buildDir, compilerArgs, configFile, configFilter, disableSourcepath, ENUNCIATE_PROPERTY, excludes, exports, exportsDir, includes, localRepository, outputDir, pluginDependencies, project, projectExtensions, projectHelper, session, skipEnunciate, sourcepathExcludes, sourcepathIncludes, sources

Fields inherited from interface org.apache.maven.reporting.MavenReport

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

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

ROLE

Constructor Summary

Constructors

Constructor and Description
DocsMojo()

Method Summary

Methods inherited from class com.webcohesion.enunciate.mojo.DocsBaseMojo

applyAdditionalConfiguration, canGenerateReport, execute, generate, getCategoryName, getDescription, getName, getOutputName, getReportOutputDirectory, getReportStagingDirectory, isExternalReport, setReportOutputDirectory

Methods inherited from class com.webcohesion.enunciate.mojo.ConfigMojo

buildPluginClasspath, findSourceVersion, findTargetVersion, getDefaultDescription, loadConfig, postProcess, postProcessConfig, setClasspathAndSourcepath

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

DocsMojo

public DocsMojo()