scala:doc

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

Full name:

org.scala-tools:maven-scala-plugin:2.9.1:doc

Description:

Produces Scala API documentation.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.

Required Parameters

Name Type Since Description
displayCmd boolean - Display the command line called ? 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
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>]]> Default value is: Copyright (c) {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved..
charset String - Charset for cross-platform viewing of generated documentation. Default value is: ISO-8859-1.
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. Default value is: ${project.name} ${project.version} API.
footer String - Include footer text for each page.
header String - Include header text for each page
jvmArgs String[] - Jvm Arguments.
linksource boolean - Generate source in HTML
name String 2.1 The name of the Scaladoc report. Default value is: ScalaDocs.
nocomment boolean - Suppress description and tags, generate only declarations
scalaVersion String - Scala 's version to use
scaladocClassName String - className (FQN) of the main scaladoc to use, if not define, the the scalaClassName is used
sourceDir File - (no description)
stylesheetfile File - File to change style of the generated documentation
top String - Include top text for each page
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. Default value is: ${project.name} ${project.version} API.

Parameter Details

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>]]>
  • 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.
  • Type: java.lang.String
  • Required: No
  • Expression: ${charset}
  • Default: ISO-8859-1

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: org.scala_tools.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 ?
  • Type: boolean
  • Required: Yes
  • Expression: ${maven.scala.displayCmd}
  • Default: false

doctitle:

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

footer:

Include footer text for each page.
  • Type: java.lang.String
  • Required: No
  • Expression: ${footer}

header:

Include header text for each page
  • Type: java.lang.String
  • Required: No
  • Expression: ${header}

jvmArgs:

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

linksource:

Generate source in HTML
  • Type: boolean
  • Required: No
  • Expression: ${linksource}

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
  • Type: boolean
  • Required: No
  • Expression: ${nocomment}

outputDirectory:

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

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

scalaVersion:

Scala 's version to use
  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.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}

sourceDir:

(no description)
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.sourceDirectory}/../scala

stylesheetfile:

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

top:

Include top text for each page
  • Type: java.lang.String
  • Required: No
  • Expression: ${top}

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.
  • Type: java.lang.String
  • Required: No
  • Expression: ${windowtitle}
  • Default: ${project.name} ${project.version} API