Kapitel 16. Entwicklung

Inhaltsverzeichnis

16.1. API-Dokumentation erzeugen

16.1. API-Dokumentation erzeugen

Welcompose verfügt über eine einigermassen vollständige API-Dokumentation, die kurz und knapp über Argumente für die jeweiligen Funktionen und deren Bedeutung informiert. Damit macht sie die Vorlagen-Entwicklung leichter, da man nicht permanent im Source Code nachschauen muss. Sie bietet damit auch deutlich mehr Informationen als die Code-Beispiele im Handbuch, die auf das Minimum beschränkt sind und vor allem weniger häufig benutzte Parameter nicht abdecken.

Eine aktuelle Version der API-Dokumentation ist über den Download-Bereich erhältlich. Man kann aber mit Hilfe des Werkzeugs phpDocumentor[27] auch selber eine API-Dokumentation erstellen, was dann sinnvoll ist, wenn man sie in einem Ausgabevormat haben möchte, das nicht zum Download angeboten wird.

phpDocumentor kann am einfachsten als PEAR-Paket installiert werden (das pear-Kommando ist Bestandteil von PHP):

$ pear install phpDocumentor

Wurde phpDocumentor installiert, können Sie dessen Funktionstüchtigkeit mit dem Kommando phpdoc überprüfen.

Nun kann die API-Dokumentation erstellt werden, beispielsweise so:

$ phpdoc --directory /pfad/zu/welcompose/core \
	--output "HTML:smarty:PHP" \
	--target "welcompose-api-docs"

Sie erhalten damit im aktuellen Verzeichnis einen Ordner api_docs/, in dem Sie die API-Dokumentation im HTML-Format vorfinden.

[Tipp] Tipp

Sollte der phpDocumentor die Erstellung der API-Doku mit einer "Memory exhausted" Meldung abbrechen, erhöhen sie den Wert des Parameter memory_size in der PHP Konfigurationsdatei (php.ini) auf 512 MB. In der Standardeinstellung steht dieser auf 128 MB, was zu oben genannten Fehler führt.