This documentation generator creates a html documentation for php classes based on the comments provided for classes, interfaces, traits, methods, variables etc. The generated output is html, css and js and can be styled with custom themes as desired.
- PHP Version >= 7.4
https://orange-management.org/Inspection/Test/Php/DocBlock/ (Guide not implemented)
A list of arguments can be found with:
php Documentor/src/index.php -h
The default usage would be:
php Documentor/src/index.php -s <SOURCE_PATH> -d <DESTINATION_PATH> -c <COVERAGE_PATH> -b <BASE_URL>
The documentation starts to shine when you use a unit test log as well as the coverage report and a html guide. The default template does not hide these pages if they are missing and the overall experience will be not as good.
-hShow help-sSource directory-dDestination directory-cCode coverage source (coverage-clover)-uUnit test log (junitstyle)-gHtml guide source-bBase uri for web access (e.g. http://www.yoururl.com/docs)
The following key words hold special meaning in the code documentation.
@var @param @version @since @latex @example @output @annotation @license @link @package @return @throws @todo @uses @see @deprecated
Coverage
Tests
Class documentation
Method documentation
