php:doxygen

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

Full name:

org.phpmaven:maven-php-plugin:1.1-SNAPSHOT:doxygen

Description:

A maven 2.0 plugin for generating doxygen documentations. This plugin is used in the site phase.

Attributes:

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

Required Parameters

Name Type Since Description
doxyGenExe String - Path to the doxygen.exe. If nothing is configured doxygen is expected in the path.
doxygenConfigFile File - The doxygen configuraton file. By default it is searched under "src/site/doxygen"
outputApiDocDirectory File - The output directory of doxygen generated documentation.
sourceDirectory String - The source code directory where doxygen start generating documentation.

Parameter Details

doxyGenExe:

Path to the doxygen.exe. If nothing is configured doxygen is expected in the path.
  • Type: java.lang.String
  • Required: Yes
  • Expression: doxygen

doxygenConfigFile:

The doxygen configuraton file. By default it is searched under "src/site/doxygen"
  • Type: java.io.File
  • Required: Yes
  • Expression: ${basedir}/src/site/doxygen/doxygen.config

outputApiDocDirectory:

The output directory of doxygen generated documentation.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.directory}/site/apidocs

sourceDirectory:

The source code directory where doxygen start generating documentation.
  • Type: java.lang.String
  • Required: Yes
  • Expression: /src/main/php