scala_maven

Class ScalaDocJarMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

scala_maven.ScalaMojoSupport

scala_maven.ScalaSourceMojoSupport

scala_maven.ScalaDocMojo

scala_maven.ScalaDocJarMojo

All Implemented Interfaces:

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

public class ScalaDocJarMojo
extends ScalaDocMojo

Creates a jar of the non-aggregated scaladoc and attaches it to the project for distribution.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	failOnError Specifies if the build will fail if there are errors during javadoc execution or not.

Fields inherited from class scala_maven.ScalaDocMojo

aggregateDirectOnly, bottom, charset, doctitle, footer, forceAggregate, header, linksource, nocomment, outputDirectory, reportOutputDirectory, scaladocClassName, sourceDir, stylesheetfile, top, vscaladocVersion, windowtitle

Fields inherited from class scala_maven.ScalaSourceMojoSupport

excludes, includes, sendJavaToScalac

Fields inherited from class scala_maven.ScalaMojoSupport

addJavacArgs, addScalacArgs, args, checkMultipleScalaVersions, compilerPlugins, dependencies, displayCmd, encoding, factory, failOnMultipleScalaVersions, forceUseArgFile, fork, javacArgs, javacGenerateDebugSymbols, jvmArgs, localRepo, mavenProjectBuilder, project, reactorProjects, remoteRepos, resolver, SCALA_COMPILER_ARTIFACTID, SCALA_LIBRARY_ARTIFACTID, scalaClassName, session, source, target, toolchainManager, useCanonicalPath

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 and Description
ScalaDocJarMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	doExecute()
protected void	failOnError(String prefix, Exception e)
protected String	getClassifier()

Methods inherited from class scala_maven.ScalaDocMojo

aggregate, canGenerateReport, generate, getCategoryName, getDescription, getName, getOutputName, getReportOutputDirectory, getScalaCommand, getSourceDirectories, isExternalReport, setReportOutputDirectory, tryAggregateUpper

Methods inherited from class scala_maven.ScalaSourceMojoSupport

findSourceWithFilters, findSourceWithFilters, initFilters, normalize

Methods inherited from class scala_maven.ScalaMojoSupport

addCompilerPluginOptions, addCompilerToClasspath, addLibraryToClasspath, addToClasspath, addToClasspath, addToClasspath, addToClasspath, checkScalaVersion, execute, findScalaVersion, findVersionFromDependencies, findVersionFromPluginArtifacts, getAllDependencies, getArtifactJar, getArtifactJar, getCompilerDependencies, getCompilerJar, getCompilerPluginOptions, getDependencies, getEmptyScalaCommand, getJavacOptions, getLibraryJar, getPluginArtifactJar, getPluginArtifactJar, getScalaOptions, getScalaOrganization, 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

failOnError

protected boolean failOnError

Specifies if the build will fail if there are errors during javadoc execution or not.

Since:

2.5

Constructor Detail

ScalaDocJarMojo

public ScalaDocJarMojo()

Method Detail

doExecute

public void doExecute()
               throws Exception

Overrides:

doExecute in class ScalaDocMojo

Throws:

Exception

getClassifier

protected String getClassifier()

failOnError

protected void failOnError(String prefix,
               Exception e)
                    throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException