info.rvin.flexmojos.asdoc
Class AsDocReport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      info.rvin.flexmojos.asdoc.AsDocMojo
          info.rvin.flexmojos.asdoc.AsDocReport

All Implemented Interfaces:

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

public class AsDocReport
extends AsDocMojo
implements org.apache.maven.reporting.MavenReport

Generates documentation for the ActionScript code in the project using the standard Asdoc tool

Author:

Justin Edelson

Field Summary

protected java.io.File

reportOutputDirectory Specifies the destination directory where javadoc saves the generated HTML files.

Fields inherited from class info.rvin.flexmojos.asdoc.AsDocMojo

artifactFactory, artifactMetadataSource, build, localRepository, mavenProjectBuilder, output, project, projectHelper, remoteRepositories, resolver, sourcePaths

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

AsDocReport()

Method Summary

boolean	canGenerateReport()
void	execute()
void	generate(org.codehaus.doxia.sink.Sink sink, java.util.Locale locale)
java.lang.String	getCategoryName()
java.lang.String	getDescription(java.util.Locale locale)
java.lang.String	getName(java.util.Locale locale)
java.lang.String	getOutputName()
java.io.File	getReportOutputDirectory()
boolean	isExternalReport()
void	setReportOutputDirectory(java.io.File outputDirectory)

Methods inherited from class info.rvin.flexmojos.asdoc.AsDocMojo

getDependencyArtifacts, run, setUp, tearDown

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

reportOutputDirectory

protected java.io.File reportOutputDirectory

Specifies the destination directory where javadoc saves the generated HTML files.

Constructor Detail

AsDocReport

public AsDocReport()

Method Detail

canGenerateReport

public boolean canGenerateReport()

Specified by:

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

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 AsDocMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

See Also:

AbstractMavenReport.execute()

generate

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

Specified by:

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

Throws:

org.apache.maven.reporting.MavenReportException

getCategoryName

public java.lang.String getCategoryName()

Specified by:

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

getDescription

public java.lang.String getDescription(java.util.Locale locale)

Specified by:

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

getName

public java.lang.String getName(java.util.Locale locale)

Specified by:

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

getOutputName

public java.lang.String getOutputName()

Specified by:

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

getReportOutputDirectory

public java.io.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

setReportOutputDirectory

public void setReportOutputDirectory(java.io.File outputDirectory)

Specified by:

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