doxygen-report:report

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

Full name:

com.github.igoryeremin:doxygen-report-maven-plugin:1.0:report

Description:

Runs Doxygen to generate API documentation.

Attributes:

  • Requires a Maven project to be executed.

Optional Parameters

Name Type Since Description
doxygenConf File - Doxygen config file location.
Default value is: ${basedir}/src/doxygen/doxygen.config.
executableName String - Doxygen executable name. Default assume it's within the PATH.
Default value is: doxygen.
input File - Doxygen INPUT parameter.
Default value is: ${basedir}/src.
outputDirectory File - Doxygen output directory.
Default value is: ${project.reporting.outputDirectory}/doxygen.

Parameter Details

doxygenConf:

Doxygen config file location.
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/src/doxygen/doxygen.config

executableName:

Doxygen executable name. Default assume it's within the PATH.
  • Type: java.lang.String
  • Required: No
  • Default: doxygen

input:

Doxygen INPUT parameter.
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/src

outputDirectory:

Doxygen output directory.
  • Type: java.io.File
  • Required: No
  • Default: ${project.reporting.outputDirectory}/doxygen