scala:genjson

Full name:

org.scala-tools:maven-scala-plugin:2.15.1:genjson

Description:

Produces Scala API documentation in Json (use vscaladoc2_genjson).

Attributes:

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

Required Parameters

Name Type Since Description
displayCmd boolean 2.15.0 Display the command line called ? (property 'maven.scala.displayCmd' replaced by 'displayCmd')
Default value is: false.
scalaClassName String 2.15.0 className (FQN) of the scala tool to provide as
Default value is: scala.tools.nsc.Main.

Optional Parameters

Name Type Since Description
args String[] 2.15.0 compiler additionnals arguments
artifactId String 2.15.0 Allow to override the artifactId used to generated json doc. Can be need sometimes (eg : for parent/group of projects)
Default value is: ${project.artifactId}.
checkMultipleScalaVersions boolean 2.15.0 Check if every dependencies use the same version of scala-library.
Default value is: true.
compilerPlugins BasicArtifact[] 2.15.0 Compiler plugin dependencies to use when compiling. ex:
dependencies BasicArtifact[] 2.15.0 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.15.0 Define the html fragment for description (use in overview page).
Default value is: ${project.description}.
excludes Set 2.15.0 A list of exclusion filters for the compiler. ex : 
   <excludes>
     <exclude>SomeBadFile.scala</exclude>
   </excludes>

failOnMultipleScalaVersions boolean 2.15.0 Determines if a detection of multiple scala versions in the dependencies will cause the build to fail.
Default value is: false.
forceUseArgFile boolean 2.15.0 Force the use of an external ArgFile to run any forked process.
Default value is: false.
fork boolean 2.15.0 Forks the execution of scalac into a separate process.
Default value is: true.
includes Set 2.15.0 A list of inclusion filters for the compiler. ex : 
   <includes>
     <include>SomeFile.scala</include>
   </includes>

jvmArgs String[] 2.15.0 Jvm Arguments.
license String 2.15.0 Define the html fragment for license (default : use info of the first entry of pom.xml/project/licenses).
linksources String 2.15.0 Define the html fragment for description (use in overview page).
logo String 2.15.0 Define the html fragment for logo.
Default value is: <a href='${project.url}'>${project.name}</a>.
overrideJson String 2.15.0 An optional json object as string used to override base configuration generated (useful for additional, not yet supported, entry)
scalaVersion String 2.15.0 Scala 's version to use. (property 'maven.scala.version' replaced by 'scala.version')
sendJavaToScalac boolean 2.15.0 Enables/Disables sending java source to the scala compiler.
Default value is: true.
sourceDir File 2.15.0 The directory which contains scala/java source files
tags String 2.15.0 Define the artifact's tags (space separator).
vscaladoc2Version String 2.15.0 Define the version of vscaladoc2_genjson to use.
Default value is: 0.3.

Parameter Details

args:

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

artifactId:

Allow to override the artifactId used to generated json doc. Can be need sometimes (eg : for parent/group of projects)
  • Type: java.lang.String
  • Since: 2.15.0
  • Required: No
  • Expression: ${genjson.artifactId}
  • Default: ${project.artifactId}

checkMultipleScalaVersions:

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

compilerPlugins:

Compiler plugin dependencies to use when compiling. ex:
  • Type: org_scala_tools_maven.BasicArtifact[]
  • Since: 2.15.0
  • 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: org_scala_tools_maven.BasicArtifact[]
  • Since: 2.15.0
  • Required: No

description:

Define the html fragment for description (use in overview page).
  • Type: java.lang.String
  • Since: 2.15.0
  • Required: No
  • Expression: ${genjson.description}
  • Default: ${project.description}

displayCmd:

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

excludes:

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

failOnMultipleScalaVersions:

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

forceUseArgFile:

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

fork:

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

includes:

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

jvmArgs:

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

license:

Define the html fragment for license (default : use info of the first entry of pom.xml/project/licenses).
  • Type: java.lang.String
  • Since: 2.15.0
  • Required: No
  • Expression: ${genjson.license}

linksources:

Define the html fragment for description (use in overview page).
  • Type: java.lang.String
  • Since: 2.15.0
  • Required: No
  • Expression: ${genjson.linksources}

logo:

Define the html fragment for logo.
  • Type: java.lang.String
  • Since: 2.15.0
  • Required: No
  • Expression: ${genjson.logo}
  • Default: <a href='${project.url}'>${project.name}</a>

overrideJson:

An optional json object as string used to override base configuration generated (useful for additional, not yet supported, entry)
  • Type: java.lang.String
  • Since: 2.15.0
  • Required: No
  • Expression: ${genjson.override}

scalaClassName:

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

scalaVersion:

Scala 's version to use. (property 'maven.scala.version' replaced by 'scala.version')
  • Type: java.lang.String
  • Since: 2.15.0
  • Required: No
  • Expression: ${scala.version}

sendJavaToScalac:

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

sourceDir:

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

tags:

Define the artifact's tags (space separator).
  • Type: java.lang.String
  • Since: 2.15.0
  • Required: No
  • Expression: ${genjson.tags}

vscaladoc2Version:

Define the version of vscaladoc2_genjson to use.
  • Type: java.lang.String
  • Since: 2.15.0
  • Required: No
  • Expression: ${genjson.version}
  • Default: 0.3