Generating the documentation

How to generate wityCMS documentation ?

We decided to use phpDocumentor 2 which is a tool derived from the merge between DocBlox and the well-known phpDocumentor. For this tutorial we will suppose that you use a Wamp server and you want to use phpDocumentor 2 from your existing Wamp installation. In order to install phpDocumentor 2 on Wamp, you'll need to install PEAR.

Installing PEAR

• First download the PEAR installation script here (PEAR).
• Find your Wamp installation directory and then go down %WAMP%\bin\php\php[PHP_VERSION]\, and then copy the file previously downloaded in this directory.
• Open a command prompt in administrator mode (normally Administrator mode is not needed but, because of a bug during the installation, I had no coice, maybe you'll have ^^).
• Execute %WAMP%\bin\php\php[PHP_VERSION]\php.exe go-pear.phar and follow the instructions.

Be careful with the initial web path which should be set to %WAMP%\www\ and you can try to change the path for the pear.ini file which by default in your C:\Windows directory (that's why you need administrator privileges, when I tried to change this path, the installation failed, so ...).

• When the script has done, don't forget to launch the reg file which has been created in your %WAMP%\bin\php\php[PHP_VERSION]\ directory.

Installing phpDocumentor 2

Just type these two commands:

pear channel-discover pear.phpdoc.org

pear install phpdoc/phpDocumentor

You're almost done. Go back in %WAMP%\bin\php\php[PHP_VERSION]\ and edit php.ini in order to remove the ; (uncomment) the line extension=php_xsl.dll (line 990 in my php.ini file).

Generating documentation

In the wityCMS project, execute makedoc.bat. The documentation will be generated in the doc directory of the project.

Finally open doc/index.html in order to view the newly-generated documentation.