br.com.anteros.restdoc.maven.plugin

Class AnterosRestDocMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.asciidoctor.maven.AsciidoctorMojo

br.com.anteros.restdoc.maven.plugin.AnterosRestDocMojo

All Implemented Interfaces:

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

@Mojo(name="generate",
      defaultPhase=PACKAGE,
      requiresDependencyResolution=COMPILE,
      requiresDependencyCollection=COMPILE)
public class AnterosRestDocMojo
extends org.asciidoctor.maven.AsciidoctorMojo

Author:

Edson Martins, Eduardo Albertini

Field Summary

Fields inherited from class org.asciidoctor.maven.AsciidoctorMojo

ASCIIDOC_REG_EXP_EXTENSION, attributeMissing, attributes, attributeUndefined, backend, baseDir, doctype, embedAssets, eruby, extensions, gemPath, headerFooter, imagesDir, preserveDirectories, projectDirectory, relativeBaseDir, requires, rootDir, skip, sourceDirectory, sourceDocumentExtensions, sourceDocumentName, sourceHighlighter, synchronizations, templateDir, templateEngine, title

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AnterosRestDocMojo()

Method Summary

Modifier and Type	Method and Description
protected org.apache.maven.plugin.javadoc.resolver.SourceResolverConfig	configureDependencySourceResolution(org.apache.maven.plugin.javadoc.resolver.SourceResolverConfig config) Override this method to customize the configuration for resolving dependency sources.
void	execute()
protected String	getClassPath()
protected List<String>	getDependencySourcePaths() Resolve dependency sources so they can be included directly in the javadoc process.
List<String>	getPackageScanEndpoints()
protected StringBuilder	getSourcesPath()

Methods inherited from class org.asciidoctor.maven.AsciidoctorMojo

ensureOutputExists, getAsciidoctorInstance, getAttributeMissing, getAttributes, getAttributeUndefined, getBackend, getBaseDir, getDoctype, getEruby, getExtensions, getGemPath, getImagesDir, getOutputDirectory, getProjectDirectory, getRootDir, getSourceDirectory, getSourceDocumentExtensions, getSourceDocumentName, getSourceHighlighter, getSynchronizations, getTemplateDir, getTemplateEngine, getTitle, isEmbedAssets, isHeaderFooter, isSkip, logRenderedFile, renderFile, setAttributeMissing, setAttributes, setAttributesOnBuilder, setAttributeUndefined, setBackend, setBaseDir, setDoctype, setEmbedAssets, setEruby, setExtensions, setGemPath, setHeaderFooter, setImagesDir, setOptions, setOutputDirectory, setPreserveDirertories, setProjectDirectory, setRelativeBaseDir, setRootDir, setSkip, setSourceDirectory, setSourceDocumentExtensions, setSourceDocumentName, setSourceHighlighter, setSynchronizations, setTemplateDir, setTemplateEngine, setTitle, synchronize

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

AnterosRestDocMojo

public AnterosRestDocMojo()

Method Detail

execute

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

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class org.asciidoctor.maven.AsciidoctorMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getSourcesPath

protected StringBuilder getSourcesPath()

getClassPath

protected String getClassPath()

getPackageScanEndpoints

public List<String> getPackageScanEndpoints()

getDependencySourcePaths

protected final List<String> getDependencySourcePaths()
                                               throws org.apache.maven.reporting.MavenReportException

Resolve dependency sources so they can be included directly in the javadoc process. To customize this, override AbstractJavadocMojo.configureDependencySourceResolution(SourceResolverConfig).

Throws:

org.apache.maven.reporting.MavenReportException

configureDependencySourceResolution

protected org.apache.maven.plugin.javadoc.resolver.SourceResolverConfig configureDependencySourceResolution(org.apache.maven.plugin.javadoc.resolver.SourceResolverConfig config)

Override this method to customize the configuration for resolving dependency sources. The default behavior enables the resolution of -sources jar files.