Mage::blog()

Mit Ant lassen sich viele Aufgaben (teil)automatisieren. Unter anderem auch das Generieren der Dokumentation auf Basis der phpDoc-Kommentare (PEAR). In der build.properties werden die folgenden drei Eigenschaften definiert:

### build.properties ###
# Pfad zur php.exe
php.bin=C:/Program Files/PHP_5.2.11/php.exe
# Verzeichnis für die Dokumentation
phpdoc.dir=doc
# Pfad zum phpDocumentor-Skript (Installation via PEAR)
phpdoc.inc=C:/Program Files/PHP_5.2.11/PEAR/PhpDocumentor/phpDocumentor/phpdoc.inc

In der build.xml wird ein neues Target für das Erstellen der Dokumentation definiert.

<!-- build.xml -->
<project name="MyProject" basedir=".">
 
	<property file="build.properties"/>
 
	<target name="phpdoc">
		<delete dir="${phpdoc.dir}" />
		<exec executable="${php.bin}" dir="${basedir}">
			<arg value="${phpdoc.inc}" />
			<arg value="-f" />
			<arg value="*.php" />
			<arg value="-t" />
			<arg value="${phpdoc.dir}" />
			<arg value="-ti" />
			<arg value="MyProject" />
		</exec>
	</target>
 
</project>

Beim Starten des Targets wird zunächst die alte Dokumentation entfernt und anschließend eine neue erzeugt.

Das Verwalten der Dokumentation via VCS ist nicht empfehlenswert, da es hierbei häufig zu Konflikten kommen kann. Bei kleineren Projekten kann sich jeder die Dokumentation mit Ant selbst erstellen. Bei größeren Projekten, wenn die Erstellung längere Zeit in Anspruch nimmt, lässt sich diese durch einen Cronjob, einen SVN-Hook oder einen CI-Server (z. B. phpUnderControl) auslagern.