Doxygen

Doxygen is een programma dat volautomatisch code omzet in klikbare documentatiepagina. De documentatie voor de livesite is te vinden op [1].

Persoonlijke docusites

WORK IN PROGRESS

Dit gaat over het plan van User:Timb om per debugsite documentatie te genereren. Dan zou voor een $bla-debug de site $bla-docs-debug.a-eskwadraat.nl beschikbaar moeten zijn.

Gebruik

./manage docs genereert documentatie op basis van je huidige wwwdebug. TODO: automatiseer dit dmv een script elke nacht ofzo?

PHPDoc

We zouden ook phpdoc kunnen gebruiken. Binnen de PHP-community lijkt het iets gebruikelijker om phpdoc te gebruiken, namelijk. Bovendien ziet het er gewoon cooler uit :D

Helaas crasht het bij het genereren van documentatie omdat het meer dan 2GB aan RAM / schijfruimte nodig heeft om de hele WhosWho te documenteren. Dus vandaar toch maar gewoon doxygen...

Installatie

pear install phpdoc op de vm-www-debug Oh nee, dat is niet stabiel over composer updaten.

Zet het volgende in je composer.json

"require-dev": {
    "phpdocumentor/phpdocumentor": "2.*"
}

en run ./composer update. Dit kost even want het moet erg veel dependencies naar binnen slurpen.