org_scala_tools_maven
Class ScalaDocMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org_scala_tools_maven.ScalaMojoSupport
          org_scala_tools_maven.ScalaSourceMojoSupport
              org_scala_tools_maven.ScalaDocMojo

All Implemented Interfaces:

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

public class ScalaDocMojo
extends ScalaSourceMojoSupport
implements org.apache.maven.reporting.MavenReport

Produces Scala API documentation.

Field Summary

protected boolean	aggregateDirectOnly If you want to aggregate only direct sub modules.
protected String	bottom Specifies the text to be placed at the bottom of each output file.
protected String	charset Charset for cross-platform viewing of generated documentation.
protected String	doctitle Include title for the overview page.
protected String	footer Include footer text for each page.
protected boolean	forceAggregate To allow running aggregation only from command line use "-Dforce-aggregate=true" (avoid using in pom.xml).
protected String	header Include header text for each page [scaladoc, vscaladoc]
protected boolean	linksource Generate source in HTML [scaladoc, vscaladoc]
protected boolean	nocomment Suppress description and tags, generate only declarations [scaladoc, vscaladoc]
protected String	scaladocClassName className (FQN) of the main scaladoc to use, if not define, the the scalaClassName is used
protected File	sourceDir The directory which contains scala/java source files
protected File	stylesheetfile File to change style of the generated documentation [scaladoc, vscaladoc]
protected String	top Include top text for each page [scaladoc, vscaladoc]
protected String	vscaladocVersion If you want to use vscaladoc to generate api instead of regular scaladoc, set the version of vscaladoc you want to use.
protected String	windowtitle Specify window title of generated HTML documentation.

Fields inherited from class org_scala_tools_maven.ScalaSourceMojoSupport

excludes, includes, sendJavaToScalac

Fields inherited from class org_scala_tools_maven.ScalaMojoSupport

args, checkMultipleScalaVersions, compilerPlugins, dependencies, displayCmd, factory, failOnMultipleScalaVersions, forceUseArgFile, fork, jvmArgs, localRepo, mavenProjectBuilder, project, remoteRepos, resolver, SCALA_GROUPID, SCALA_LIBRARY_ARTIFACTID, scalaClassName

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

ScalaDocMojo()

Method Summary

protected void	aggregate(org.apache.maven.project.MavenProject parent)
boolean	canGenerateReport()
void	doExecute()
void	generate(org.codehaus.doxia.sink.Sink sink, Locale locale)
String	getCategoryName()
String	getDescription(Locale locale)
String	getName(Locale locale)
String	getOutputName()
File	getReportOutputDirectory()
protected JavaMainCaller	getScalaCommand()
protected List<File>	getSourceDirectories() Retreives the list of *all* root source directories.
boolean	isExternalReport()
void	setReportOutputDirectory(File v)
protected void	tryAggregateUpper(org.apache.maven.project.MavenProject prj)

Methods inherited from class org_scala_tools_maven.ScalaSourceMojoSupport

findSourceWithFilters, findSourceWithFilters, initFilters, normalize, normalize

Methods inherited from class org_scala_tools_maven.ScalaMojoSupport

addCompilerPluginOptions, addToClasspath, addToClasspath, addToClasspath, checkScalaVersion, execute, findScalaVersion, getDependencies, getEmptyScalaCommand, isJavaSupportedByCompiler, resolveArtifactDependencies, resolveDependencyArtifacts

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

windowtitle

protected String windowtitle

Specify window title of generated HTML documentation. [scaladoc, vscaladoc]

bottom

protected String bottom

Specifies the text to be placed at the bottom of each output file. If you want to use html you have to put it in a CDATA section, eg. <![CDATA[Copyright 2005, <a href="http://www.mycompany.com">MyCompany, Inc.<a>]]> [scaladoc, vscaladoc]

charset

protected String charset

Charset for cross-platform viewing of generated documentation. [scaladoc, vscaladoc]

doctitle

protected String doctitle

Include title for the overview page. [scaladoc, scaladoc2, vscaladoc]

footer

protected String footer

Include footer text for each page. [scaladoc, vscaladoc]

header

protected String header

Include header text for each page [scaladoc, vscaladoc]

linksource

protected boolean linksource

Generate source in HTML [scaladoc, vscaladoc]

nocomment

protected boolean nocomment

Suppress description and tags, generate only declarations [scaladoc, vscaladoc]

stylesheetfile

protected File stylesheetfile

File to change style of the generated documentation [scaladoc, vscaladoc]

top

protected String top

Include top text for each page [scaladoc, vscaladoc]

scaladocClassName

protected String scaladocClassName

className (FQN) of the main scaladoc to use, if not define, the the scalaClassName is used

vscaladocVersion

protected String vscaladocVersion

If you want to use vscaladoc to generate api instead of regular scaladoc, set the version of vscaladoc you want to use.

forceAggregate

protected boolean forceAggregate

To allow running aggregation only from command line use "-Dforce-aggregate=true" (avoid using in pom.xml). [scaladoc, vscaladoc]

aggregateDirectOnly

protected boolean aggregateDirectOnly

If you want to aggregate only direct sub modules.

sourceDir

protected File sourceDir

The directory which contains scala/java source files

Constructor Detail

ScalaDocMojo

public ScalaDocMojo()

Method Detail

getSourceDirectories

protected List<File> getSourceDirectories()
                                   throws Exception

Description copied from class: ScalaSourceMojoSupport

Retreives the list of *all* root source directories. We need to pass all .java and .scala files into the scala compiler

Specified by:

getSourceDirectories in class ScalaSourceMojoSupport

Throws:

Exception

canGenerateReport

public boolean canGenerateReport()

Specified by:

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

isExternalReport

public boolean isExternalReport()

Specified by:

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

getCategoryName

public String getCategoryName()

Specified by:

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

getDescription

public String getDescription(Locale locale)

Specified by:

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

getName

public String getName(Locale locale)

Specified by:

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

getOutputName

public String getOutputName()

Specified by:

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

getReportOutputDirectory

public File getReportOutputDirectory()

Specified by:

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

setReportOutputDirectory

public void setReportOutputDirectory(File v)

Specified by:

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

doExecute

public void doExecute()
               throws Exception

Specified by:

doExecute in class ScalaMojoSupport

Throws:

Exception

getScalaCommand

protected JavaMainCaller getScalaCommand()
                                  throws Exception

Overrides:

getScalaCommand in class ScalaMojoSupport

Throws:

Exception

generate

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

Specified by:

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

Throws:

org.apache.maven.reporting.MavenReportException

tryAggregateUpper

protected void tryAggregateUpper(org.apache.maven.project.MavenProject prj)
                          throws Exception

Throws:

Exception

aggregate

protected void aggregate(org.apache.maven.project.MavenProject parent)
                  throws Exception

Throws:

Exception