php:phpdocumentor

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

Full name:

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

Description:

A maven 2.0 plugin for generating phpdocumentor 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
outputApiDocDirectory File - The output directory of doxygen generated documentation.
phpDocConfigFile File - The phpdoc configuraton file. By default it is searched under "src/site/phpdoc"
phpDocFilePath String - Path to phpDoc. If nothing is configured phpdoc is expected in the path.
phpExe String - Path to the php executable.
sourceDirectory String - The source code directory where doxygen start generating documentation.

Parameter Details

outputApiDocDirectory:

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

phpDocConfigFile:

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

phpDocFilePath:

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

phpExe:

Path to the php executable.
  • Type: java.lang.String
  • Required: Yes
  • Expression: php

sourceDirectory:

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