Vor einigen Wochen hatte ich an dieser Stelle über die Integration von PHPUnit berichtet. Gestern nun folgte die Einbindung von phpDocumentor, dem de facto Standardwerkzeug, wenn es um API-Dokumentationen für PHP-Applikationen geht. phpDocumentor wird ebenfalls als externes Tool eingebunden: Run -> External Tools. Über verschiedene Parameter bspw. für das Template oder den Titel der Dokumentation lässt sich das Ergebnis steuern. Eine Übersicht über die Optionen findet sich hier.
Der Screenshot zeigt die Einstellungen, mit der die API-Doku der aktuellen SVN-Version von PHPTMAPI 2.0 generiert worden ist (bitte anklicken für bessere Lesbarkeit):
“/var/www/phpdoc/PhpDocumentor-1.4.2/phpdoc” gibt den Pfad zum phpdoc Shell-Script an, “/home/johannes/apidoc/${project_name}” den Zielordner. Über einen Klick auf “Run” (External Tools) aus dem oberen Menü wird dann für das aktuell geöffnete Projekt die Dokumentation erzeugt.
Keine Kommentare
Kommentare zu diesem Beitrag als RSS 2.0 feed.
Kommentar abgeben