info.rvin.flexmojos.asdoc
Class AsDocMojo

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AsDocReport

public class AsDocMojo
extends org.apache.maven.plugin.AbstractMojo

Goal which generates documentation from the ActionScript sources.

Field Summary

protected org.apache.maven.artifact.factory.ArtifactFactory	artifactFactory
protected org.apache.maven.artifact.metadata.ArtifactMetadataSource	artifactMetadataSource
protected org.apache.maven.model.Build	build
protected org.apache.maven.artifact.repository.ArtifactRepository	localRepository
protected org.apache.maven.project.MavenProjectBuilder	mavenProjectBuilder
protected java.io.File	output The output directory for the generated documentation.
protected org.apache.maven.project.MavenProject	project The maven project.
protected org.apache.maven.project.MavenProjectHelper	projectHelper
protected java.util.List	remoteRepositories
protected org.apache.maven.artifact.resolver.ArtifactResolver	resolver
protected java.io.File[]	sourcePaths List of path elements that form the roots of ActionScript class hierarchies.

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

ROLE

Constructor Summary

AsDocMojo()

Method Summary

void	execute()
protected java.util.Set<org.apache.maven.artifact.Artifact>	getDependencyArtifacts() Returns Set of dependency artifacts which are resolved for the project.
protected void	run()
protected void	setUp()
protected void	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

project

protected org.apache.maven.project.MavenProject project

The maven project.

build

protected org.apache.maven.model.Build build

projectHelper

protected org.apache.maven.project.MavenProjectHelper projectHelper

artifactFactory

protected org.apache.maven.artifact.factory.ArtifactFactory artifactFactory

resolver

protected org.apache.maven.artifact.resolver.ArtifactResolver resolver

artifactMetadataSource

protected org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource

mavenProjectBuilder

protected org.apache.maven.project.MavenProjectBuilder mavenProjectBuilder

localRepository

protected org.apache.maven.artifact.repository.ArtifactRepository localRepository

remoteRepositories

protected java.util.List remoteRepositories

output

protected java.io.File output

The output directory for the generated documentation. The default value is "asdoc-output".

sourcePaths

protected java.io.File[] sourcePaths

List of path elements that form the roots of ActionScript class hierarchies.

Constructor Detail

AsDocMojo

public AsDocMojo()

Method Detail

setUp

protected void setUp()
              throws org.apache.maven.plugin.MojoExecutionException,
                     org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

run

protected void run()
            throws org.apache.maven.plugin.MojoExecutionException,
                   org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

tearDown

protected void tearDown()
                 throws org.apache.maven.plugin.MojoExecutionException,
                        org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getDependencyArtifacts

protected java.util.Set<org.apache.maven.artifact.Artifact> getDependencyArtifacts()
                                                                            throws org.apache.maven.plugin.MojoExecutionException

Returns Set of dependency artifacts which are resolved for the project.

Returns:

Set of dependency artifacts.

Throws:

org.apache.maven.plugin.MojoExecutionException