erlang:test-doc

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

Full name:

eu.lindenbaum:maven-erlang-plugin:1.0.0-beta:test-doc

Description:

This Mojo will generate EDoc documentation for the test sources found in AbstractErlangReport.srcTestErlang.

The output will be put into AbstractErlangReport.targetSite/test-doc. The user may specify custom EDoc options in the project pom using the eDocOptions parameter.

BUG It is known that edoc does not generate a charset meta tag for the resulting html output.

BUG It is known that doxia overwrites the reports index.html with a broken template when the report is invoked as standalone.

Attributes:

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

Optional Parameters

Name Type Since Description
eDocOptions String[] - Additional options for EDoc.

Parameter Details

eDocOptions:

Additional options for EDoc.
  • Type: java.lang.String[]
  • Required: No