org.apache.maven.plugin.docck

Class CheckPluginDocumentationMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugin.docck.AbstractCheckDocumentationMojo

org.apache.maven.plugin.docck.CheckPluginDocumentationMojo

All Implemented Interfaces:

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

@Mojo(name="check",
      aggregator=true,
      defaultPhase=VALIDATE,
      threadSafe=true)
public class CheckPluginDocumentationMojo
extends AbstractCheckDocumentationMojo

Checks a plugin's documentation for the standard minimums.

Author:

jdcasey

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.maven.tools.plugin.scanner.MojoScanner	mojoScanner Plexus component that searches for Mojos.

Fields inherited from class org.apache.maven.plugin.docck.AbstractCheckDocumentationMojo

siteDirectory

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

ROLE

Constructor Summary

Constructors

Constructor and Description
CheckPluginDocumentationMojo()

Method Summary

Modifier and Type	Method and Description
protected boolean	approveProjectPackaging(String packaging)
protected void	checkPackagingSpecificDocumentation(org.apache.maven.project.MavenProject project, DocumentationReporter reporter)

Methods inherited from class org.apache.maven.plugin.docck.AbstractCheckDocumentationMojo

execute, findFiles, getReactorProjects

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

Field Detail

mojoScanner

@Component
protected org.apache.maven.tools.plugin.scanner.MojoScanner mojoScanner

Plexus component that searches for Mojos.

Constructor Detail

CheckPluginDocumentationMojo

public CheckPluginDocumentationMojo()

Method Detail

checkPackagingSpecificDocumentation

protected void checkPackagingSpecificDocumentation(org.apache.maven.project.MavenProject project,
                                                   DocumentationReporter reporter)

Specified by:

checkPackagingSpecificDocumentation in class AbstractCheckDocumentationMojo

approveProjectPackaging

protected boolean approveProjectPackaging(String packaging)

Specified by:

approveProjectPackaging in class AbstractCheckDocumentationMojo