phpDocumentor unter Windows zu verwenden, ist im Prinzip nicht schwierig, wenn man erst einmal weiß wie. Die folgende Anleitung zeigt dies Schritt für Schritt.

phpDocumentor installieren

Für dieses Beispiel nutze ich die .phar-Version von phpDocumentor. Diese kann man z.B. über GitHub herunterladen. Die Datei kann man dann in das www-Verzeichnis von WAMP legen oder in ein beliebiges Projektverzeichnis. Ich nutze als Beispiel hier: C:\wamp\www\wordpress\wp-content\plugins\teachpress Weiterhin benötigt phpDocumentor noch die Installation von Graphviz.

Umgebungsvariablen von Windows ändern

phpDocumentor ist zur Verwendung mittels Kommandozeilen-Tools ausgelegt. Powershell bzw. CMD.exe können aber nicht direkt PHP-Skripte ausführen. Damit das geht, muss man unter Windows in der Benutzervariable „PATH“ den Pfad zur php.exe von WAMP eintragen. Das geht unter Windows 7/8 folgendermaßen:

1. Öffne die Systemsteuerung und wähle „Erweiterte Systemsteuerung“.

sys_01

2. Wähle dort den Tab „Erweitert“ und klicke anschließend auf „Umgebungsvariablen“.

sys_02

3. Wähle die Benutzervariable „PATH“ und klicke danach auf „Bearbeiten“.

sys_03

4. In dem anschließend erscheinenden Fenster muss der Wert der Variable geändert werden. Die verschiedenen Pfade, welche hier angegeben werden, lassen sich per Semikolon (;) trennen. Daher kann man den benötigten Pfad einfach am Ende anfügen. Ich habe hier C:\wamp\bin\php\php5.4.3 eingtragen. Je nach verwendeter PHP-Version kann sich der Pfad natürlich unterscheiden.

sys_04

PHP-Erweiterungen aktivieren

Damit phpDocumentor richtig funktioniert, müssen bestimmte PHP-Erweiterungen (php_xsl und php_intl) aktiviert sein. Dabei bringt es nichts, diese über das WAMPServer-Menü zu aktivieren, denn damit konfiguriert man nur die php.ini für den Apache-Server. Innerhalb des WAMP-Verzeichnisses gibt es mehrere php.ini, aus denen man an dieser Stelle die richtige auswählen und bearbeiten muss. (Die Datei liegt in dem selben Verzeichnis, welches im vorherigen Schritt in der PATH-Variable von Windows eingetragen wurde.)

sys_05

Hat man die Datei gefunden, muss man einfach nur im Editor die richtige Zeile suchen und das Semikolon(;) vor folgenden Zeilen entfernen:

extension=php_intl.dll
extension=php_xsl.dll

sys_06

phpDocumentor ausführen

Nachdem die Vorbereitungen abgeschlossen sind, lässt sich phpDocumentor ausführen. Dazu kann man entweder PowerShell oder die altbekannte Cmd.exe starten.

Als erstes wechselt man zu dem Verzeichnis, in das man vorher die Datei phpDocumentor.phar gelegt hat. In meinem Fall wäre das:

cd C:\wamp\www\wordpress\wp-content\plugins\teachpress

Als letzten Schritt kann man nun phpDocumentor ausführen. Beispiel:

php phpDocumentor.phar -d . -t docs/api

sys_07

Weitere Infos zu den Parametern, die sich an dieser Stelle angeben lassen, sind in der Doku von phpDocumentor zu finden.