Create documentation for your project
To create a documentation simply run:
<!-- Doxygen Documentation -->
<plugin>
<groupId>org.phpmaven</groupId>
<artifactId>maven-php-plugin</artifactId>
<!-- Optional -->
<reportSet>
<reports>
<report>doxygen</report>
<report>phpdocumentor</report>
</reports>
</reportSet>
<!-- / Optional -->
</plugin>
Following documentations will be created.
PHPDocumentor
"PHP for Maven" extends the Maven default documentation
by adding a phpdocumentor goal.
Doxygen
"PHP for Maven" extends the Maven default documentation
by adding a doxygen goal.
What happened?
Doxygen:
Maven generates a standard documenation. Through the
doxygen goal, an api doc is created. The doxygen
configuration file must be located under
src/site/doxygen/doxygen.conf. The following parameters
of the doxygen.conf will be replaced by the plugin.
INPUT
OUTPUT_DIRECTORY
PROJECT_NAME
PROJECT_NUMBER
PHPDocumentor:
Through the phpdocumnetor goal, an api doc is created. The phpdocumnetor
configuration file must be located under
src/site/phpdoc/phpdoc.conf. The following parameters
of the phpdoc.conf will be replaced by the plugin.