Normalerweise werden beim Erstellen von Doku mit
phpDocumentor Dateien mit folgenden Endungen (file extensions) als "zu parsende" Dateien beachtet:
php, php3, php4, phtml, inc
Soweit so gut.
Es gibt aber (zumindest bei mir) immer wieder Projekte, in denen es Dateien mit anderen Endungen gibt die man auch dokumentiert haben möchte.
Beispiel: Config-Files (.cfg), Templates (.tmpl), usw.
Einen entprechenden Parameter beim Aufruf von phpDocumentor habe ich (leider) nicht gefunden.
"Irgendwann" hatte ich das mal "irgendwo" umgestellt/geändert, aber dummerweise nicht dokumentiert wie und wo...
Prompt war nach einem Update von phpDocumentor auf Version 1.4 meine tolle "Lösung" des Problems weg und ich durfte noch mal suchen wie, wo, was...
Nunja. Daher hier jetzt die Doku für mich und wenn es sonst noch interessiert ;-)
Die Notwendige Änderung der Konfiguration muss in der Datei phpDocumentor.ini des phpDocumentor Paketes vorgenommen werden.
Angenommen das Basis-Verzeichnis für die pear Pakete ist:
/usr/local/lib/php/pear
Dann liegt die Datei unter:
/usr/local/lib/php/pear/data/PhpDocumentor/phpDocumentor.ini
Im Zweifelsfall ist z.B. folgender Befehl dein Freund um die Datei zu finden:
pear list-files PhpDocumentor | grep phpDocumentor.ini
Die eigentliche Änderung ist dann einfach: Im entspr. Block der Config-Datei einfach die gewünschten Endungen anfügen.
[_phpDocumentor_phpfile_exts]
php
php3
php4
phtml
inc
tmpl
Datei speichern und wie gewohnt die Doku mit phpdoc erstellen.
Achja, sachdienliche Hinweise wie man das hinbekommt OHNE in der phpDocumentor.ini Änderungen machen zu müssen sind jederzeit willkommen.
