org.mule.devkit.maven

Class EnsureJavaDocMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.mule.devkit.maven.AbstractMuleMojo

org.mule.devkit.maven.AbstractAnnotationProcessorMojo

org.mule.devkit.maven.AnnotationProcessorMojo

org.mule.devkit.maven.EnsureJavaDocMojo

All Implemented Interfaces:

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

@Mojo(name="ensure-javadoc",
      requiresDependencyResolution=COMPILE)
public class EnsureJavaDocMojo
extends AnnotationProcessorMojo

Used for validation purposes only, this mojo will guarantee that the current compilation will have the necessary javadocs for every field, parameter, method, etc., that devkit needs to generate the documentation

Field Summary

Fields inherited from class org.mule.devkit.maven.AnnotationProcessorMojo

connectorJavadocs, generateApidocs, LICENSE_DESCRIPTOR_FILE_NAME

Fields inherited from class org.mule.devkit.maven.AbstractMuleMojo

appDirectory, finalName, project, skipStudioPluginPackage, studioPackageTimeout, verboseEnabled

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

ROLE

Constructor Summary

Constructors

Constructor and Description
EnsureJavaDocMojo()

Method Summary

Modifier and Type	Method and Description
protected void	addCompilerJavadocArgument(List<String> options) As we are validating in this "ensure-javadoc" goal, we want to validate *always* that the connector is properly documented
protected void	addCompilerStudioPluginArgument(List<String> options) As we are validating in this "ensure-javadoc" goal, it does not have sense to generate the Studio plugin

Methods inherited from class org.mule.devkit.maven.AnnotationProcessorMojo

addCompilerArguments, addCompileSourceRoot, addVerboseLoggingArguments, getClasspathElements, getDefaultOutputDirectory, getOutputClassDirectory, getProcessors

Methods inherited from class org.mule.devkit.maven.AbstractAnnotationProcessorMojo

execute

Methods inherited from class org.mule.devkit.maven.AbstractMuleMojo

getFilteredAppDirectory, getMuleZipFile

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

EnsureJavaDocMojo

public EnsureJavaDocMojo()

Method Detail

addCompilerJavadocArgument

protected void addCompilerJavadocArgument(List<String> options)

As we are validating in this "ensure-javadoc" goal, we want to validate *always* that the connector is properly documented

Overrides:

addCompilerJavadocArgument in class AnnotationProcessorMojo

Parameters:

options -

addCompilerStudioPluginArgument

protected void addCompilerStudioPluginArgument(List<String> options)

As we are validating in this "ensure-javadoc" goal, it does not have sense to generate the Studio plugin

Overrides:

addCompilerStudioPluginArgument in class AnnotationProcessorMojo

Parameters:

options -