scala:doc-jar

Note:

This goal should be used as a Maven report.

Full name:

net.alchim31.maven:scala-maven-plugin:4.9.3:doc-jar

Description:

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

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Binds by default to the lifecycle phase: package.
  • Invokes the execution of the following lifecycle phase prior to executing itself: generate-sources.

Required Parameters

Name Type Since Description
<displayCmd> boolean - Display the command line called ? (property 'maven.scala.displayCmd' replaced by 'displayCmd')
Default: false
User Property: displayCmd
<outputDirectory> String - Specifies the destination directory where scalaDoc saves the generated HTML files.
Default: scaladocs
<reportOutputDirectory> File - Specifies the destination directory where javadoc saves the generated HTML files.
Default: ${project.reporting.outputDirectory}/scaladocs

Optional Parameters

Name Type Since Description
<addJavacArgs> String - Alternative method for specifying javac arguments (when using incremental compiler). Can be used from command line with -DaddJavacArgs=arg1|arg2|arg3|... rather than in pom.xml.
User Property: addJavacArgs
<addScalacArgs> String - Additional parameter to use to call the main class. Use this parameter only from command line ("-DaddScalacArgs=arg1|arg2|arg3|..."), not from pom.xml. To define compiler arguments in pom.xml see the "args" parameter.
User Property: addScalacArgs
<additionalDependencies> Dependency[] - Additional dependencies to be added to the classpath. This can be useful in situations where a dependency is needed at compile time, but should not be treated as a dependency in the published POM.
User Property: additionalDependencies
<archive> MavenArchiveConfiguration - The archive configuration to use. See Maven Archiver Reference.
<args> String[] - compiler additional arguments
<attach> boolean - Specifies whether to attach the generated artifact to the project helper.

Default: true
User Property: attach
<checkMultipleScalaVersions> boolean - Check if every dependencies use the same version of scala-library or scala.compat.version.
Default: true
User Property: maven.scala.checkConsistency
<classifier> String - Specifies the classifier of the generated artifact.
Default: javadoc
User Property: classifier
<compilerPlugins> BasicArtifact[] - Compiler plugin dependencies to use when compiling. ex: 
<compilerPlugins>
  <compilerPlugin>
    <groupId>my.scala.plugin</groupId>
    <artifactId>amazingPlugin</artifactId>
    <version>1.0-SNAPSHOT</version>
  </compilerPlugin>
</compilerPlugins>
<dependencies> BasicArtifact[] - Additional dependencies/jar to add to classpath to run "scalaClassName" (scope and optional field not supported) ex : 
   <dependencies>
     <dependency>
       <groupId>org.scala-tools</groupId>
       <artifactId>scala-compiler-addon</artifactId>
       <version>1.0-SNAPSHOT</version>
     </dependency>
   </dependencies>
<description> String 2.1 The description of the Scaladoc report.
Default: ScalaDoc API documentation.
User Property: description
<doctitle> String - Include title for the overview page.
Default: ${project.name} ${project.version} API
User Property: doctitle
<encoding> String - The -encoding argument for the Java compiler. (when using incremental compiler).
Default: UTF-8
User Property: project.build.sourceEncoding
<excludes> Set<String> - A list of exclusion filters for the compiler. ex : 
   <excludes>
     <exclude>SomeBadFile.scala</exclude>
   </excludes>
<failOnError> boolean 2.5 Specifies if the build will fail if there are errors during javadoc execution or not.
Default: true
User Property: maven.javadoc.failOnError
<failOnMultipleScalaVersions> boolean - Determines if a detection of multiple scala versions in the dependencies will cause the build to fail.
Default: false
<finalName> String - Specifies the filename that will be used for the generated jar file. Please note that -javadoc or -test-javadoc will be appended to the file name.
User Property: project.build.finalName
<forceUseArgFile> boolean - Force the use of an external ArgFile to run any forked process.
Default: false
<fork> boolean - Forks the execution of scalac into a separate process.
Default: true
<includes> Set<String> - A list of inclusion filters for the compiler. ex : 
   <includes>
     <include>SomeFile.scala</include>
   </includes>
<jarOutputDirectory> String - Specifies the directory where the generated jar file will be put.
User Property: project.build.directory
<javacArgs> String[] - Arguments for javac (when using incremental compiler).
User Property: javacArgs
<javacGenerateDebugSymbols> boolean - Whether to instruct javac to generate debug symbols (when using incremental compiler)
See also: ://maven.apache.org/plugins/maven-compiler-plugin/compile-mojo.html#debug
Default: true
User Property: javacGenerateDebugSymbols
<jvmArgs> String[] - Jvm Arguments.
<name> String 2.1 The name of the Scaladoc report.
Default: ScalaDocs
User Property: name
<pluginArtifacts> List<Artifact> - List of artifacts to run plugin
Default: ${plugin.artifacts}
<release> String - The --release argument for the Java compiler (when using incremental compiler), supported since Java9.
User Property: maven.compiler.release
<scalaClassName> String - override the className (FQN) of the scala tool
User Property: maven.scala.className
<scalaCompatVersion> String - Scala 's version to use to check binary compatibility (like suffix in artifactId of dependency). If it is defined then it is used to checkMultipleScalaVersions
User Property: scala.compat.version
<scalaHome> String - Path to Scala installation to use instead of the artifact (define as dependencies).
User Property: scala.home
<scalaOrganization> String - Organization/group ID of the Scala used in the project. Default value is 'org.scala-lang'. This is an advanced setting used for clones of the Scala Language. It should be disregarded in standard use cases.
Default: org.scala-lang
User Property: scala.organization
<scalaVersion> String - Scala 's version to use. (property 'maven.scala.version' replaced by 'scala.version')
User Property: scala.version
<scaladocClassName> String - className (FQN) of the main scaladoc to use, if not define, the the scalaClassName is used
User Property: maven.scaladoc.className
<sendJavaToScalac> boolean - Enables/Disables sending java source to the scala compiler.
Default: true
<skip> boolean - Specifies whether to skip generating scaladoc.
Default: false
User Property: skip
<source> String - The -source argument for the Java compiler (when using incremental compiler).
User Property: maven.compiler.source
<sourceDir> File - The directory which contains scala/java source files
Default: ${project.build.sourceDirectory}/../scala
<target> String - The -target argument for the Java compiler (when using incremental compiler).
User Property: maven.compiler.target
<useCanonicalPath> boolean - Should use CanonicalPath to normalize path (true => getCanonicalPath, false => getAbsolutePath)
See also: https://github.com/davidB/scala-maven-plugin/issues/50
Default: true
User Property: maven.scala.useCanonicalPath
<useDefaultManifestFile> boolean - Set this to true to enable the use of the defaultManifestFile.

Default: false

Parameter Details

<addJavacArgs>

Alternative method for specifying javac arguments (when using incremental compiler). Can be used from command line with -DaddJavacArgs=arg1|arg2|arg3|... rather than in pom.xml.
  • Type: java.lang.String
  • Required: No
  • User Property: addJavacArgs

<addScalacArgs>

Additional parameter to use to call the main class. Use this parameter only from command line ("-DaddScalacArgs=arg1|arg2|arg3|..."), not from pom.xml. To define compiler arguments in pom.xml see the "args" parameter.
  • Type: java.lang.String
  • Required: No
  • User Property: addScalacArgs

<additionalDependencies>

Additional dependencies to be added to the classpath. This can be useful in situations where a dependency is needed at compile time, but should not be treated as a dependency in the published POM.
  • Type: org.apache.maven.model.Dependency[]
  • Required: No
  • User Property: additionalDependencies

<archive>

The archive configuration to use. See Maven Archiver Reference.
  • Type: org.apache.maven.archiver.MavenArchiveConfiguration
  • Required: No

<args>

compiler additional arguments
  • Type: java.lang.String[]
  • Required: No

<attach>

Specifies whether to attach the generated artifact to the project helper.
  • Type: boolean
  • Required: No
  • User Property: attach
  • Default: true

<checkMultipleScalaVersions>

Check if every dependencies use the same version of scala-library or scala.compat.version.
  • Type: boolean
  • Required: No
  • User Property: maven.scala.checkConsistency
  • Default: true

<classifier>

Specifies the classifier of the generated artifact.
  • Type: java.lang.String
  • Required: No
  • User Property: classifier
  • Default: javadoc

<compilerPlugins>

Compiler plugin dependencies to use when compiling. ex: 
<compilerPlugins>
  <compilerPlugin>
    <groupId>my.scala.plugin</groupId>
    <artifactId>amazingPlugin</artifactId>
    <version>1.0-SNAPSHOT</version>
  </compilerPlugin>
</compilerPlugins>
  • Type: scala_maven.BasicArtifact[]
  • Required: No

<dependencies>

Additional dependencies/jar to add to classpath to run "scalaClassName" (scope and optional field not supported) ex : 
   <dependencies>
     <dependency>
       <groupId>org.scala-tools</groupId>
       <artifactId>scala-compiler-addon</artifactId>
       <version>1.0-SNAPSHOT</version>
     </dependency>
   </dependencies>
  • Type: scala_maven.BasicArtifact[]
  • Required: No

<description>

The description of the Scaladoc report.
  • Type: java.lang.String
  • Since: 2.1
  • Required: No
  • User Property: description
  • Default: ScalaDoc API documentation.

<displayCmd>

Display the command line called ? (property 'maven.scala.displayCmd' replaced by 'displayCmd')
  • Type: boolean
  • Required: Yes
  • User Property: displayCmd
  • Default: false

<doctitle>

Include title for the overview page.
  • Type: java.lang.String
  • Required: No
  • User Property: doctitle
  • Default: ${project.name} ${project.version} API

<encoding>

The -encoding argument for the Java compiler. (when using incremental compiler).
  • Type: java.lang.String
  • Required: No
  • User Property: project.build.sourceEncoding
  • Default: UTF-8

<excludes>

A list of exclusion filters for the compiler. ex : 
   <excludes>
     <exclude>SomeBadFile.scala</exclude>
   </excludes>
  • Type: java.util.Set<java.lang.String>
  • Required: No

<failOnError>

Specifies if the build will fail if there are errors during javadoc execution or not.
  • Type: boolean
  • Since: 2.5
  • Required: No
  • User Property: maven.javadoc.failOnError
  • Default: true

<failOnMultipleScalaVersions>

Determines if a detection of multiple scala versions in the dependencies will cause the build to fail.
  • Type: boolean
  • Required: No
  • Default: false

<finalName>

Specifies the filename that will be used for the generated jar file. Please note that -javadoc or -test-javadoc will be appended to the file name.
  • Type: java.lang.String
  • Required: No
  • User Property: project.build.finalName

<forceUseArgFile>

Force the use of an external ArgFile to run any forked process.
  • Type: boolean
  • Required: No
  • Default: false

<fork>

Forks the execution of scalac into a separate process.
  • Type: boolean
  • Required: No
  • Default: true

<includes>

A list of inclusion filters for the compiler. ex : 
   <includes>
     <include>SomeFile.scala</include>
   </includes>
  • Type: java.util.Set<java.lang.String>
  • Required: No

<jarOutputDirectory>

Specifies the directory where the generated jar file will be put.
  • Type: java.lang.String
  • Required: No
  • User Property: project.build.directory

<javacArgs>

Arguments for javac (when using incremental compiler).
  • Type: java.lang.String[]
  • Required: No
  • User Property: javacArgs

<javacGenerateDebugSymbols>

Whether to instruct javac to generate debug symbols (when using incremental compiler)
See also: ://maven.apache.org/plugins/maven-compiler-plugin/compile-mojo.html#debug
  • Type: boolean
  • Required: No
  • User Property: javacGenerateDebugSymbols
  • Default: true

<jvmArgs>

Jvm Arguments.
  • Type: java.lang.String[]
  • Required: No

<name>

The name of the Scaladoc report.
  • Type: java.lang.String
  • Since: 2.1
  • Required: No
  • User Property: name
  • Default: ScalaDocs

<outputDirectory>

Specifies the destination directory where scalaDoc saves the generated HTML files.
  • Type: java.lang.String
  • Required: Yes
  • Default: scaladocs

<pluginArtifacts>

List of artifacts to run plugin
  • Type: java.util.List<org.apache.maven.artifact.Artifact>
  • Required: No
  • Default: ${plugin.artifacts}

<release>

The --release argument for the Java compiler (when using incremental compiler), supported since Java9.
  • Type: java.lang.String
  • Required: No
  • User Property: maven.compiler.release

<reportOutputDirectory>

Specifies the destination directory where javadoc saves the generated HTML files.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.reporting.outputDirectory}/scaladocs

<scalaClassName>

override the className (FQN) of the scala tool
  • Type: java.lang.String
  • Required: No
  • User Property: maven.scala.className

<scalaCompatVersion>

Scala 's version to use to check binary compatibility (like suffix in artifactId of dependency). If it is defined then it is used to checkMultipleScalaVersions
  • Type: java.lang.String
  • Required: No
  • User Property: scala.compat.version

<scalaHome>

Path to Scala installation to use instead of the artifact (define as dependencies).
  • Type: java.lang.String
  • Required: No
  • User Property: scala.home

<scalaOrganization>

Organization/group ID of the Scala used in the project. Default value is 'org.scala-lang'. This is an advanced setting used for clones of the Scala Language. It should be disregarded in standard use cases.
  • Type: java.lang.String
  • Required: No
  • User Property: scala.organization
  • Default: org.scala-lang

<scalaVersion>

Scala 's version to use. (property 'maven.scala.version' replaced by 'scala.version')
  • Type: java.lang.String
  • Required: No
  • User Property: scala.version

<scaladocClassName>

className (FQN) of the main scaladoc to use, if not define, the the scalaClassName is used
  • Type: java.lang.String
  • Required: No
  • User Property: maven.scaladoc.className

<sendJavaToScalac>

Enables/Disables sending java source to the scala compiler.
  • Type: boolean
  • Required: No
  • Default: true

<skip>

Specifies whether to skip generating scaladoc.
  • Type: boolean
  • Required: No
  • User Property: skip
  • Default: false

<source>

The -source argument for the Java compiler (when using incremental compiler).
  • Type: java.lang.String
  • Required: No
  • User Property: maven.compiler.source

<sourceDir>

The directory which contains scala/java source files
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.sourceDirectory}/../scala

<target>

The -target argument for the Java compiler (when using incremental compiler).
  • Type: java.lang.String
  • Required: No
  • User Property: maven.compiler.target

<useCanonicalPath>

Should use CanonicalPath to normalize path (true => getCanonicalPath, false => getAbsolutePath)
See also: https://github.com/davidB/scala-maven-plugin/issues/50
  • Type: boolean
  • Required: No
  • User Property: maven.scala.useCanonicalPath
  • Default: true

<useDefaultManifestFile>

Set this to true to enable the use of the defaultManifestFile.
  • Type: boolean
  • Required: No
  • Default: false