Difference between revisions of "PHPDoc"
From A-Eskwiki
(Created page with "'''WORK IN PROGRESS''' Ter vervanging van [https://doxygen-www.a-eskwadraat.nl Doxygen] ben ik bezig om [https://docs.phpdoc.org/ phpdoc] op te zetten. Binnen de PHP-communit...") |
(→Installatie) |
||
| Line 11: | Line 11: | ||
== Installatie == | == Installatie == | ||
| − | <code>pear install phpdoc</code> op de [[vm-www-debug]] | + | <strike><code>pear install phpdoc</code> op de [[vm-www-debug]]</strike> Oh nee, dat is niet stabiel over composer updaten. |
| + | |||
| + | Zet het volgende in je <code>composer.json</code> | ||
| + | <code><pre> | ||
| + | "require-dev": { | ||
| + | "phpdocumentor/phpdocumentor": "2.*" | ||
| + | } | ||
| + | </pre></code> | ||
| + | en run <code>./composer update</code>. Dit kost even want het moet erg veel dependencies naar binnen slurpen. | ||
[[Category:WebCie]] | [[Category:WebCie]] | ||
Revision as of 12:24, 18 December 2017
WORK IN PROGRESS
Ter vervanging van Doxygen ben ik bezig om phpdoc op te zetten. Binnen de PHP-community lijkt het iets gebruikelijker om phpdoc te gebruiken, namelijk. Bovendien ziet het er gewoon cooler uit :D
Gebruik
Als je debugsite $bla-debug.a-eskwadraat.nl heet, dan kun je op $bla-docs-debug.a-eskwadraat.nl je documentatie zien. (TODO: zet dit in wwwdebug.sh-script)
./manage docs genereert documentatie op basis van je huidige wwwdebug. TODO: automatiseer dit dmv een script elke nacht ofzo?
Installatie
pear install phpdoc op de vm-www-debug
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.
