Click here to lend your support to: scala-maven-plugin and make a donation at www.pledgie.com !

scala:doc

Note:This goal should be used as a Maven report.

Full name:

net.alchim31.maven:scala-maven-plugin:3.2.0:doc

Description:

Produces Scala API documentation.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • Invokes the execution of the lifecycle phase generate-sources prior to executing itself.

Required Parameters

Name Type Since Description
displayCmd boolean - Display the command line called ? (property 'maven.scala.displayCmd' replaced by 'displayCmd')
Default value is: false.
outputDirectory String - Specifies the destination directory where scalaDoc saves the generated HTML files.
reportOutputDirectory File - Specifies the destination directory where javadoc saves the generated HTML files.
scalaClassName String - className (FQN) of the scala tool to provide as
Default value is: scala.tools.nsc.Main.

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.
addScalacArgs String - Additional parameter to use to call the main class Using this parameter only from command line ("-DaddScalacArgs=arg1|arg2|arg3|..."), not from pom.xml.
aggregateDirectOnly boolean - If you want to aggregate only direct sub modules.
Default value is: true.
args String[] - compiler additionnals arguments
bottom String - 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]
Default value is: Copyright (c) {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved..
charset String - Charset for cross-platform viewing of generated documentation. [scaladoc, vscaladoc]
Default value is: ISO-8859-1.
checkMultipleScalaVersions boolean - Check if every dependencies use the same version of scala-library or scala.compat.version.
Default value is: true.
compilerPlugins BasicArtifact[] - Compiler plugin dependencies to use when compiling. ex:
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 value is: ScalaDoc API.
doctitle String - Include title for the overview page. [scaladoc, scaladoc2, vscaladoc]
Default value is: ${project.name} ${project.version} API.
encoding String - The -encoding argument for the Java compiler. (when using incremental compiler).
excludes Set - A list of exclusion filters for the compiler. ex :
   <excludes>
     <exclude>SomeBadFile.scala</exclude>
   </excludes>

failOnMultipleScalaVersions boolean - Determines if a detection of multiple scala versions in the dependencies will cause the build to fail.
Default value is: false.
footer String - Include footer text for each page. [scaladoc, vscaladoc]
forceAggregate boolean - To allow running aggregation only from command line use "-DforceAggregate=true" (avoid using in pom.xml). [scaladoc, vscaladoc]
Default value is: false.
forceUseArgFile boolean - Force the use of an external ArgFile to run any forked process.
Default value is: false.
fork boolean - Forks the execution of scalac into a separate process.
Default value is: true.
header String - Include header text for each page [scaladoc, vscaladoc]
includes Set - A list of inclusion filters for the compiler. ex :
   <includes>
     <include>SomeFile.scala</include>
   </includes>

javacArgs String[] - Arguments for javac (when using incremental compiler).
javacGenerateDebugSymbols boolean - Whether to instruct javac to generate debug symbols (when using incremental compiler)
Default value is: true.
jvmArgs String[] - Jvm Arguments.
linksource boolean - Generate source in HTML [scaladoc, vscaladoc]
Default value is: true.
name String 2.1 The name of the Scaladoc report.
Default value is: ScalaDocs.
nocomment boolean - Suppress description and tags, generate only declarations [scaladoc, vscaladoc]
Default value is: false.
pluginArtifacts List - (no description)
Default value is: ${plugin.artifacts}.
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
scalaHome String - Path to Scala installation to use instead of the artifact (define as dependencies).
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 value is: org.scala-lang.
scalaVersion String - Scala 's version to use. (property 'maven.scala.version' replaced by 'scala.version')
scaladocClassName String - className (FQN) of the main scaladoc to use, if not define, the the scalaClassName is used
sendJavaToScalac boolean - Enables/Disables sending java source to the scala compiler.
Default value is: true.
source String - The -source argument for the Java compiler (when using incremental compiler).
sourceDir File - The directory which contains scala/java source files
stylesheetfile File - File to change style of the generated documentation [scaladoc, vscaladoc]
target String - The -target argument for the Java compiler (when using incremental compiler).
top String - Include top text for each page [scaladoc, vscaladoc]
useCanonicalPath boolean - Should use CanonicalPath to normalize path (true => getCanonicalPath, false => getAbsolutePath)
Default value is: true.
vscaladocVersion String - If you want to use vscaladoc to generate api instead of regular scaladoc, set the version of vscaladoc you want to use.
windowtitle String - Specify window title of generated HTML documentation. [scaladoc, vscaladoc]
Default value is: ${project.name} ${project.version} API.

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
  • Expression: ${addJavacArgs}

addScalacArgs:

Additional parameter to use to call the main class Using this parameter only from command line ("-DaddScalacArgs=arg1|arg2|arg3|..."), not from pom.xml.
  • Type: java.lang.String
  • Required: No
  • Expression: ${addScalacArgs}

aggregateDirectOnly:

If you want to aggregate only direct sub modules.
  • Type: boolean
  • Required: No
  • Expression: ${maven.scaladoc.aggregateDirectOnly}
  • Default: true

args:

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

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]
  • Type: java.lang.String
  • Required: No
  • Expression: ${bottom}
  • Default: Copyright (c) {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.

charset:

Charset for cross-platform viewing of generated documentation. [scaladoc, vscaladoc]
  • Type: java.lang.String
  • Required: No
  • Expression: ${charset}
  • Default: ISO-8859-1

checkMultipleScalaVersions:

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

compilerPlugins:

Compiler plugin dependencies to use when compiling. ex:
  • 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
  • Expression: ${description}
  • Default: ScalaDoc API

displayCmd:

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

doctitle:

Include title for the overview page. [scaladoc, scaladoc2, vscaladoc]
  • Type: java.lang.String
  • Required: No
  • Expression: ${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
  • Expression: ${project.build.sourceEncoding}

excludes:

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

failOnMultipleScalaVersions:

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

footer:

Include footer text for each page. [scaladoc, vscaladoc]
  • Type: java.lang.String
  • Required: No
  • Expression: ${footer}

forceAggregate:

To allow running aggregation only from command line use "-DforceAggregate=true" (avoid using in pom.xml). [scaladoc, vscaladoc]
  • Type: boolean
  • Required: No
  • Expression: ${forceAggregate}
  • Default: false

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

header:

Include header text for each page [scaladoc, vscaladoc]
  • Type: java.lang.String
  • Required: No
  • Expression: ${header}

includes:

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

javacArgs:

Arguments for javac (when using incremental compiler).
  • Type: java.lang.String[]
  • Required: No
  • Expression: ${javacArgs}

javacGenerateDebugSymbols:

Whether to instruct javac to generate debug symbols (when using incremental compiler)
  • Type: boolean
  • Required: No
  • Expression: ${javacGenerateDebugSymbols}
  • Default: true

jvmArgs:

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

linksource:

Generate source in HTML [scaladoc, vscaladoc]
  • Type: boolean
  • Required: No
  • Expression: ${linksource}
  • Default: true

name:

The name of the Scaladoc report.
  • Type: java.lang.String
  • Since: 2.1
  • Required: No
  • Expression: ${name}
  • Default: ScalaDocs

nocomment:

Suppress description and tags, generate only declarations [scaladoc, vscaladoc]
  • Type: boolean
  • Required: No
  • Expression: ${nocomment}
  • Default: false

outputDirectory:

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

pluginArtifacts:

(no description)
  • Type: java.util.List
  • Required: No
  • Default: ${plugin.artifacts}

reportOutputDirectory:

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

scalaClassName:

className (FQN) of the scala tool to provide as
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${maven.scala.className}
  • Default: scala.tools.nsc.Main

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
  • Expression: ${scala.compat.version}

scalaHome:

Path to Scala installation to use instead of the artifact (define as dependencies).
  • Type: java.lang.String
  • Required: No
  • Expression: ${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
  • Expression: ${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
  • Expression: ${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
  • Expression: ${maven.scaladoc.className}

sendJavaToScalac:

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

source:

The -source argument for the Java compiler (when using incremental compiler).
  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.compiler.source}

sourceDir:

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

stylesheetfile:

File to change style of the generated documentation [scaladoc, vscaladoc]
  • Type: java.io.File
  • Required: No
  • Expression: ${stylesheetfile}

target:

The -target argument for the Java compiler (when using incremental compiler).
  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.compiler.target}

top:

Include top text for each page [scaladoc, vscaladoc]
  • Type: java.lang.String
  • Required: No
  • Expression: ${top}

useCanonicalPath:

Should use CanonicalPath to normalize path (true => getCanonicalPath, false => getAbsolutePath)
  • Type: boolean
  • Required: No
  • Expression: ${maven.scala.useCanonicalPath}
  • Default: true

vscaladocVersion:

If you want to use vscaladoc to generate api instead of regular scaladoc, set the version of vscaladoc you want to use.
  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.scaladoc.vscaladocVersion}

windowtitle:

Specify window title of generated HTML documentation. [scaladoc, vscaladoc]
  • Type: java.lang.String
  • Required: No
  • Expression: ${windowtitle}
  • Default: ${project.name} ${project.version} API