E-mail
CiviCRM code contains inline documentation which is formatted using the phpdoc standard. This allows you to generate (and update) browsable easily-readable local documentation. Follow the steps below install PhpDocumentor and generate the documentation files.
1. Download and Install PhpDocumentor
From a command prompt, with root privileges, enter:
You should see the following output:
2. Run the Documentation Create Script
CiviCRM includes a script in the /bin folder to create the code documentation - createdoc.sh.
3. Browse Documentation
Documentation will be generated in the /docs/documentation folder under your civicrm install folder and can be browsed from there. For example:
Labels:
