phpDocumentor

PhpDocumentor is an open-source documentation generator written in PHP. It automatically parses PHP source code and produces readable API and source code documentation, based on PHPDoc-formatted comments and the structure of the source code itself. It supports documentation of both object-oriented and procedural code.

Installing process on Ubuntu

If you are using windows, it would be so easy to install PhpDocumentor on Ubuntu. So here is the installation link of Ubuntu on Windows. https://www.youtube.com/watch?v=X-DHaQLrBi8&fbclid=IwAR0S_prR2RzXiWpoeBvghwjh7tJnDkMIi1RIOtVfN5b5QPYuz36yaxULzBg Then install PHP on Ubuntu. So here is the installation link of Php on Ubutu. https://www.youtube.com/watch?v=xAU3Tb7mm80 Then run the command "php --version" to ensure the php is installed. On Ubuntu command prompt go to the project directory and follow the installing Phpdocumentor part by phar on this link . https://docs.phpdoc.org/3.0/guide/getting-started/installing.html After downloading the phar file put the file on the project directory, then run a command on the project directory through Ubuntu cmd. The command is " $ php phpDocumentor.phar -d . -t docs/api " . If you face any error like "the extension "simplexml". Enable it or install a polyfill." , then close the Ubuntu Cmd and open Ubuntu cmd again & run this command " $ sudo apt-get install php-xml ". After that again go to the project directory through Ubuntu cmd and run the command again on this directory " $ php phpDocumentor.phar -d . -t docs/api ". Hopefully it will run smoothly and create a folder docs/api on your project directory. Go there docs/api and open index.html file. So finally you can find your project documentation by Phpdocumentor tool there.