erlang:edoc

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

Full name:

eu.lindenbaum:maven-erlang-plugin:2.0.0:edoc

Description:

This Mojo will generate source code documentation for an application.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Invokes the execution of the lifecycle phase generate-resources prior to executing itself.

Optional Parameters

Name Type Since Description
cookie String - The cookie to use for the java and the backend node.
erlCommand String - The erlang command used to start an erlang backend node. The path must exist and the destination must be executable. If the given command does not fullfill these requirements erl is used (assuming the command is part of the hosts PATH). The path must not contain any arguments.

Parameter Details

cookie:

The cookie to use for the java and the backend node.
  • Type: java.lang.String
  • Required: No
  • Expression: ${cookie}

erlCommand:

The erlang command used to start an erlang backend node. The path must exist and the destination must be executable. If the given command does not fullfill these requirements erl is used (assuming the command is part of the hosts PATH). The path must not contain any arguments.
  • Type: java.lang.String
  • Required: No
  • Expression: ${erlCommand}