phpDocumentor ist ein Tool um Dokumentationen für PHP-Code zu erstellen.

Der Quellcode wird dazu mit einer PHPDoc-Syntax annotiert. Beispiel

/**
Example function
 
@param $parameter parameter for the example function 
 
@return true always return true
*/
function testFunction($parameter){
    return true;
}

Seit Version 3 muss das Ausgabeverzeichnis in transformer und parser gesetzt werden:

<parser>
  <target>.phpdoc/build</target>
</parser>
<transformer>
  <target>.phpdoc/build</target>
</transformer>

phpDocumentor kann liest seine Datei aus phpdoc.xml oder phpdoc.dist.xml. Die Empfohlene Variante ist im Projekt eine phpdoc.dist.xml einzuchecken, so dass jeder bei Bedarf eine eigene phpdoc.xml anlegen kann, die Vorrang vor der phpdoc.dist.xml hat.

• Homepage