V bakalářce jsem popisoval rozhodování mezi různými nástroji na generování PHP API dokumentace v rámci kontinuální integrace. Teď se výběr zjednodušil, proto z nástroje DocBlox se stal se phpDocumentor 2. Sice se v článku mluví o merge", ale ve skutečnosti jde o "přejmenování s tím, že původní phpDocumentor se přestane vyvíjet.
Nainstalovat ho můžeme pomocí:
pear channel-discover pear.phpdoc.org
pear install phpdoc/phpDocumentor-alpha
Kromě výchozí šablony jsou k dispozici i nějaké další, ale nešly mi doinstalovat starým postupem tak jako u DocBloxu, ale musel jsem přes PEAR:
pear install phpdoc/phpDocumentor_Template_checkstyle
pear install phpdoc/phpDocumentor_Template_zend
Přehled všech dostupných šablon najdete na webu
Generování funguje pořád stejně, jen je potřeba vyměnit docblox za phpdoc:
phpdoc -f phpdoc01.php
phpdoc -f phpdoc01.php --template checkstyle
Na výchozí šabloně mě překvapilo, že v detailu třídy nikde není vypsané její jméno. Holt je to ještě alpha.
Až bude phpDocumentor 2 stabilní, tak určitě bude dobré znovu zvážit výběr nástroje na generování API dokumentace. Přechod z DocBloxu je jasný, ale pokud se objeví i šablona podobná té v ApiGenu, tak bych kvůli cachování analyzovaných souborů (zrychlení oceníte hlavně u větších projektů) zvážil přechod na phpDocumentor.
Čím generujte API dokumentaci v PHP vy?