Note: This goal should be used as a Maven report.
Full name:
org.scala-tools:maven-scala-plugin:2.9.1:doc
Description:
Attributes:
compile
.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 . |
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 . |
args:
java.lang.String[]
No
java.lang.String
No
${bottom}
Copyright (c) {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.
java.lang.String
No
${charset}
ISO-8859-1
org.scala_tools.maven.BasicArtifact[]
No
java.lang.String
2.1
No
${description}
ScalaDoc API
boolean
Yes
${maven.scala.displayCmd}
false
java.lang.String
No
${doctitle}
${project.name} ${project.version} API
java.lang.String
No
${footer}
java.lang.String
No
${header}
java.lang.String[]
No
boolean
No
${linksource}
name:
java.lang.String
2.1
No
${name}
ScalaDocs
boolean
No
${nocomment}
java.lang.String
Yes
scaladocs
java.io.File
Yes
${project.reporting.outputDirectory}/scaladocs
java.lang.String
Yes
${maven.scala.className}
scala.tools.nsc.Main
java.lang.String
No
${maven.scala.version}
java.lang.String
No
${maven.scaladoc.className}
java.io.File
No
${project.build.sourceDirectory}/../scala
java.io.File
No
${stylesheetfile}
top:
java.lang.String
No
${top}
java.lang.String
No
${maven.scaladoc.vscaladocVersion}
java.lang.String
No
${windowtitle}
${project.name} ${project.version} API