Fork me on GitHub
Built by Maven

scalor:report-main

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

Full name:

com.carrotgarden.maven:scalor-maven-plugin_2.12:1.5.0.20190502181145:report-main

Description:

Produce Scaladoc site report for compilation scope=[macro,main]. A member of goal=report.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • Binds by default to the lifecycle phase: package.

Optional Parameters

Name Type Since Description
<reportMainReportDescription> String - (no description)
Default value is: Scala Documentation.
User property is: scalor.reportMainReportDescription.
<reportMainReportName> String - (no description)
Default value is: ScalaDoc.
User property is: scalor.reportMainReportName.
<reportMainReportOutputDirectory> File - (no description)
Default value is: ${project.reporting.outputDirectory}/scaladoc-main.
User property is: scalor.reportMainReportOutputDirectory.
<reportMainReportRelativeFolder> String - (no description)
Default value is: scaladoc-main.
User property is: scalor.reportMainReportRelativeFolder.
<skip> boolean - Force to skip all executions of this plugin.
Default value is: false.
User property is: scalor.skip.
<skipLogReason> boolean - Enable logging of reason for skipping an execution.
Default value is: true.
User property is: scalor.skipLogReason.
<skipPackagingList> String[] - List of packaging types, which are skipped by this plugin.
Default value is: pom.
User property is: scalor.skipPackagingList.
<skipReport> boolean - Flag to skip document execution: report-*.
Default value is: false.
User property is: scalor.skipReport.
<skipReportMain> boolean - Flag to skip goal execution: report-main.
Default value is: false.
User property is: scalor.skipReportMain.

Parameter Details

<reportMainReportDescription>

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.reportMainReportDescription
  • Default: Scala Documentation

<reportMainReportName>

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.reportMainReportName
  • Default: ScalaDoc

<reportMainReportOutputDirectory>

(no description)
  • Type: java.io.File
  • Required: No
  • User Property: scalor.reportMainReportOutputDirectory
  • Default: ${project.reporting.outputDirectory}/scaladoc-main

<reportMainReportRelativeFolder>

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: scalor.reportMainReportRelativeFolder
  • Default: scaladoc-main

<skip>

Force to skip all executions of this plugin.
  • Type: boolean
  • Required: No
  • User Property: scalor.skip
  • Default: false

<skipLogReason>

Enable logging of reason for skipping an execution.
  • Type: boolean
  • Required: No
  • User Property: scalor.skipLogReason
  • Default: true

<skipPackagingList>

List of packaging types, which are skipped by this plugin.
  • Type: java.lang.String[]
  • Required: No
  • User Property: scalor.skipPackagingList
  • Default: pom

<skipReport>

Flag to skip document execution: report-*.
  • Type: boolean
  • Required: No
  • User Property: scalor.skipReport
  • Default: false

<skipReportMain>

Flag to skip goal execution: report-main.
  • Type: boolean
  • Required: No
  • User Property: scalor.skipReportMain
  • Default: false