Package com.github.matinh.vdldoc.maven.plugins

Class Vdldoc

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.matinh.vdldoc.maven.plugins.Vdldoc

All Implemented Interfaces:

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

@Mojo(name="vdldoc",
      defaultPhase=SITE)
@Execute(phase=GENERATE_SOURCES)
public class Vdldoc
extends org.apache.maven.plugin.AbstractMojo
implements org.apache.maven.reporting.MavenReport

Generate documentation for JSF tag libraries via OmniFaces Vdldoc.

Since:

1.0-alpha-1

Author:

martin

Field Summary

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	Description
Vdldoc()

Method Summary

Modifier and Type	Method	Description
boolean	canGenerateReport()
void	execute()
void	generate(org.apache.maven.doxia.sink.Sink sink, Locale locale)	Generate the actual report.
void	generate(org.codehaus.doxia.sink.Sink sink, Locale locale)	Deprecated.
String	getCategoryName()
String	getDescription(Locale locale)
String	getName(Locale locale)
String	getOutputName()
File	getReportOutputDirectory()
boolean	isExternalReport()
void	setReportOutputDirectory(File file)

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 Details

Vdldoc

public Vdldoc()

Method Details

execute

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

Specified by:

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

Throws:

org.apache.maven.plugin.MojoExecutionException

generate

@Deprecated
public void generate(org.codehaus.doxia.sink.Sink sink,
 Locale locale)
              throws org.apache.maven.reporting.MavenReportException

Deprecated.

Specified by:

generate in interface org.apache.maven.reporting.MavenReport

Throws:

org.apache.maven.reporting.MavenReportException

generate

public void generate(org.apache.maven.doxia.sink.Sink sink,
 Locale locale)
              throws org.apache.maven.reporting.MavenReportException

Generate the actual report.

This method delegates to execute() and generates the actual report. It is needed by the (new) maven reporting API.

Parameters:

sink - currently ignored.

locale - currently ignored.

Throws:

org.apache.maven.reporting.MavenReportException - on any problem during report generation.

See Also:

• generate(org.codehaus.doxia.sink.Sink, Locale)

getOutputName

public String getOutputName()

Specified by:

getOutputName in interface org.apache.maven.reporting.MavenReport

getCategoryName

public String getCategoryName()

Specified by:

getCategoryName in interface org.apache.maven.reporting.MavenReport

getName

public String getName(Locale locale)

Specified by:

getName in interface org.apache.maven.reporting.MavenReport

getDescription

public String getDescription(Locale locale)

Specified by:

getDescription in interface org.apache.maven.reporting.MavenReport

setReportOutputDirectory

public void setReportOutputDirectory(File file)

Specified by:

setReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

getReportOutputDirectory

public File getReportOutputDirectory()

Specified by:

getReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

isExternalReport

public boolean isExternalReport()

Specified by:

isExternalReport in interface org.apache.maven.reporting.MavenReport

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface org.apache.maven.reporting.MavenReport