erlang:edoc

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

Full name:

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

Description:

Generate the edoc report.

Attributes:

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

Required Parameters

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

Optional Parameters

Name Type Since Description
applicationResourceFile String - Application resource file (in src/ directory).
edocDestDir String - Name of the destination directory. Default value is: edoc.
edocOptions String[] - Edoc options.
erlPath String - Path to the erlang installation directory.
sourceDirectory File - Directory with module source code.

Parameter Details

applicationResourceFile :

Application resource file (in src/ directory).
  • Type: java.lang.String
  • Required: No

edocDestDir :

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

edocOptions :

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

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}/edoc

sourceDirectory :

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