Generate API Documentation¶
Powered by PHP Documentor
Download phpDocumentor.php [https://github.com/phpDocumentor/phpDocumentor/releases]
Set Path in .env File¶
PHPDOCUMENTOR_PATH=E:/Soft/phpdoc/phpDocumentor.phar
Commands¶
Syntax: php cli app:api-doc location type code dest
php cli app:apidoc backend module marketplace "d:/www/practice/phspark/doc/api/"
More...
php /d/Soft/phpdoc/phpDocumentor.phar --version
php /d/Soft/phpdoc/phpDocumentor.phar run -h
php /d/Soft/phpdoc/phpDocumentor.phar -d "c:\www\phspark\system\library" -t "c:\www\phspark\dev\doc"
php /d/Soft/phpdoc/phpDocumentor.phar -t "c:\www\phspark\dev\doc" -d "c:\www\phspark\backend\model" --force
php /d/Soft/phpdoc/phpDocumentor.phar -d "c:\www\phspark\system\library" -t "c:\www\phspark\dev\doc" --force --ignore-symlinks
php /d/Soft/phpdoc/phpDocumentor.phar -t "c:\www\phspark\dev\doc" -d "c:\www\phspark\backend\model" -i "frontend" -i "people" --force
php /d/Soft/phpdoc/phpDocumentor.phar -t "c:\www\phspark\dev\doc" -d "c:\www\phspark\traits" -d "c:\www\phspark\backend\model" --force
php /d/Soft/phpdoc/phpDocumentor.phar -t "c:\www\phspark\dev\doc" -d "c:\www\phspark" -i "dev" --force
c:/xampp/php/php.exe E:/Soft/phpdoc/phpDocumentor.phar -t c:/www/practice/phspark_practice/doc/api\Backend-module-marketplace -d c:\www \phspark_practice\backend\extension\module\marketplace\controller/api --title Marketplace-module-API --force
Problem & Solution¶
Not working with PHP 8
[WARNING] Some commands could not be registered:
Solution not found yet!