Note:This goal should be used as a Maven report.
Full name:
net.alchim31.maven:scala-maven-plugin:4.8.1:doc-jar
Description:
Attributes:
compile
.package
.generate-sources
prior to executing itself.Name | Type | Since | Description |
---|---|---|---|
<displayCmd> |
boolean |
- |
Display the command line called ? (property 'maven.scala.displayCmd' replaced by 'displayCmd') Default value is: false .User property is: displayCmd . |
<outputDirectory> |
String |
- |
Specifies the destination directory where scalaDoc saves the generated HTML files. Default value is: scaladocs . |
<reportOutputDirectory> |
File |
- |
Specifies the destination directory where javadoc saves the generated HTML files. Default value is: ${project.reporting.outputDirectory}/scaladocs . |
Name | Type | Since | Description |
---|---|---|---|
<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 is: additionalDependencies . |
<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 is: 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 is: addScalacArgs . |
<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 value is: true .User property is: attach . |
<checkMultipleScalaVersions> |
boolean |
- |
Check if every dependencies use the same version of scala-library or scala.compat.version. Default value is: true .User property is: maven.scala.checkConsistency . |
<classifier> |
String |
- |
Specifies the classifier of the generated artifact. Default value is: javadoc .User property is: 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 value is: ScalaDoc API documentation. .User property is: description . |
<doctitle> |
String |
- |
Include title for the overview page. Default value is: ${project.name} ${project.version} API .User property is: doctitle . |
<encoding> |
String |
- |
The -encoding argument for the Java compiler. (when using incremental compiler). Default value is: UTF-8 .User property is: 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 value is: true .User property is: maven.javadoc.failOnError . |
<failOnMultipleScalaVersions> |
boolean |
- |
Determines if a detection of multiple scala versions in the dependencies will cause the build to fail. Default value is: 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 is: project.build.finalName . |
<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 . |
<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 is: project.build.directory . |
<javacArgs> |
String[] |
- |
Arguments for javac (when using incremental compiler). User property is: 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 value is: true .User property is: javacGenerateDebugSymbols . |
<jvmArgs> |
String[] |
- |
Jvm Arguments. |
<name> |
String |
2.1 |
The name of the Scaladoc report. Default value is: ScalaDocs .User property is: name . |
<pluginArtifacts> |
List<Artifact> |
- |
List of artifacts to run plugin Default value is: ${plugin.artifacts} . |
<release> |
String |
- |
The --release argument for the Java compiler (when using incremental compiler), supported since Java9. User property is: maven.compiler.release . |
<scalaClassName> |
String |
- |
override the className (FQN) of the scala tool User property is: 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 is: scala.compat.version . |
<scaladocClassName> |
String |
- |
className (FQN) of the main scaladoc to use, if not define, the the scalaClassName is used User property is: maven.scaladoc.className . |
<scalaHome> |
String |
- |
Path to Scala installation to use instead of the artifact (define as dependencies). User property is: 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 value is: org.scala-lang .User property is: scala.organization . |
<scalaVersion> |
String |
- |
Scala 's version to use. (property 'maven.scala.version' replaced by 'scala.version') User property is: scala.version . |
<sendJavaToScalac> |
boolean |
- |
Enables/Disables sending java source to the scala compiler. Default value is: true . |
<skip> |
boolean |
- |
Specifies whether to skip generating scaladoc. Default value is: false .User property is: skip . |
<source> |
String |
- |
The -source argument for the Java compiler (when using incremental compiler). User property is: maven.compiler.source . |
<sourceDir> |
File |
- |
The directory which contains scala/java source files Default value is: ${project.build.sourceDirectory}/../scala . |
<target> |
String |
- |
The -target argument for the Java compiler (when using incremental compiler). User property is: 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 value is: true .User property is: maven.scala.useCanonicalPath . |
<useDefaultManifestFile> |
boolean |
- |
Set this to true to enable the use of the defaultManifestFile . Default value is: false . |
org.apache.maven.model.Dependency[]
No
additionalDependencies
java.lang.String
No
addJavacArgs
java.lang.String
No
addScalacArgs
org.apache.maven.archiver.MavenArchiveConfiguration
No
java.lang.String[]
No
boolean
No
attach
true
boolean
No
maven.scala.checkConsistency
true
java.lang.String
No
classifier
javadoc
<compilerPlugins> <compilerPlugin> <groupId>my.scala.plugin</groupId> <artifactId>amazingPlugin</artifactId> <version>1.0-SNAPSHOT</version> </compilerPlugin> </compilerPlugins>
scala_maven.BasicArtifact[]
No
<dependencies> <dependency> <groupId>org.scala-tools</groupId> <artifactId>scala-compiler-addon</artifactId> <version>1.0-SNAPSHOT</version> </dependency> </dependencies>
scala_maven.BasicArtifact[]
No
java.lang.String
2.1
No
description
ScalaDoc API documentation.
boolean
Yes
displayCmd
false
java.lang.String
No
doctitle
${project.name} ${project.version} API
java.lang.String
No
project.build.sourceEncoding
UTF-8
<excludes> <exclude>SomeBadFile.scala</exclude> </excludes>
java.util.Set<java.lang.String>
No
boolean
2.5
No
maven.javadoc.failOnError
true
boolean
No
false
-javadoc
or -test-javadoc
will be appended to the file name.java.lang.String
No
project.build.finalName
boolean
No
false
boolean
No
true
<includes> <include>SomeFile.scala</include> </includes>
java.util.Set<java.lang.String>
No
java.lang.String
No
project.build.directory
java.lang.String[]
No
javacArgs
boolean
No
javacGenerateDebugSymbols
true
java.lang.String[]
No
java.lang.String
2.1
No
name
ScalaDocs
java.lang.String
Yes
scaladocs
java.util.List<org.apache.maven.artifact.Artifact>
No
${plugin.artifacts}
java.lang.String
No
maven.compiler.release
java.io.File
Yes
${project.reporting.outputDirectory}/scaladocs
java.lang.String
No
maven.scala.className
java.lang.String
No
scala.compat.version
java.lang.String
No
maven.scaladoc.className
java.lang.String
No
scala.home
java.lang.String
No
scala.organization
org.scala-lang
java.lang.String
No
scala.version
boolean
No
true
boolean
No
skip
false
java.lang.String
No
maven.compiler.source
java.io.File
No
${project.build.sourceDirectory}/../scala
java.lang.String
No
maven.compiler.target
boolean
No
maven.scala.useCanonicalPath
true
true
to enable the use of the defaultManifestFile
. boolean
No
false