erlang:test-edoc

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

Full name:

net.sf.maven-erlang:erlang-plugin:1.0-SNAPSHOT:test-edoc

Description:

Generate the edoc report for test source.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Binds by default to the lifecycle phase: generate-test-sources.

Required Parameters

Name Type Since Description
outputDirectory File - Destination directory. Default value is: ${project.reporting.outputDirectory}/test-edoc.

Optional Parameters

Name Type Since Description
erlPath String - Path to the erlang installation directory.
testEdocDestDir String - Name of the destination directory. Default value is: test-edoc.
testEdocOptions String[] - Edoc options.
testSourceDirectory File - Directory with module test source code.

Parameter Details

erlPath :

Path to the erlang installation directory.
  • Type: java.lang.String
  • Required: No

outputDirectory :

Destination directory.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.reporting.outputDirectory}/test-edoc

testEdocDestDir :

Name of the destination directory.
  • Type: java.lang.String
  • Required: No
  • Expression: ${testEdocDestDir}
  • Default: test-edoc

testEdocOptions :

Edoc options.
  • Type: java.lang.String[]
  • Required: No

testSourceDirectory :

Directory with module test source code.
  • Type: java.io.File
  • Required: No
  • Expression: ${basedir}/src/test/erlang/