Note:This goal should be used as a Maven report.
Full name:
org.phpmaven:maven-php-plugin:2.0-SNAPSHOT:phpdocumentor
Description:
Attributes:
| Name | Type | Since | Description |
|---|---|---|---|
| outputApiDocDirectory | File | - | The output directory of doxygen generated documentation. |
| phpDocConfigFile | File | - | The phpdoc configuraton file. The default is
${project.basedir}/src/site/phpdoc/phpdoc.config Default value is: ${project.basedir}/src/site/phpdoc/phpdoc.config. |
| Name | Type | Since | Description |
|---|---|---|---|
| additionalPhpParameters | String | - | PHP arguments. Use php -h to get a list of all php compile
arguments. |
| dependenciesTargetDirectory | File | - | Where the php dependency files will be written to. Default value is: ${project.basedir}/target/php-deps. |
| excludes | String[] | - | Files and directories to exclude. |
| ignoreIncludeErrors | boolean | - | If true, errors triggered because of missing includes will be
ignored. Default value is: false. |
| includes | String[] | - | Files and directories to include. |
| logPhpOutput | boolean | - | If the output of the php scripts will be written to the console. Default value is: false. |
| phpDocFilePath | String | - | Path to phpDoc. If nothing is configured phpdoc is expected in the
path. Default value is: phpdoc. |
| phpExecutable | String | - | Path to the php executable. Default value is: php. |
| phpFileEnding | String | - | How php files will be identified after the last point. Default value is: php. |
| targetClassesDirectory | File | - | The directory containing generated classes of the project being
tested. This will be included after the test classes in the test
classpath. Default value is: ${project.build.outputDirectory}. |
| targetTestClassesDirectory | File | - | The directory containing generated test classes of the project
being tested. This will be included at the beginning of the test
classpath. Default value is: ${project.build.testOutputDirectory}. |
| temporaryScriptFile | File | - | A temporary script file that can be used for php execution of small
code snippets. Default value is: ${project.basedir}/target/snippet.php. |
| testDependenciesTargetDirectory | File | - | Where the php test dependency files will be written to. Default value is: ${project.basedir}/target/php-test-deps. |
testDependenciesTargetDirectory: