====== phpDocumentor ======
phpDocumentor ist ein Tool um Dokumentationen für [[PHP|PHP-Code]] zu erstellen.

Der Quellcode wird dazu mit einer PHPDoc-Syntax annotiert.
Beispiel
<code php>
/**
Example function

@param $parameter parameter for the example function 

@return true always return true
*/
function testFunction($parameter){
    return true;
}
</code>

===== Ausgabeverzeichnis =====
Seit Version 3 muss das Ausgabeverzeichnis in ''transformer'' und ''parser'' gesetzt werden:
<code xml>
<parser>
  <target>.phpdoc/build</target>
</parser>
<transformer>
  <target>.phpdoc/build</target>
</transformer>
</code>

===== phpdoc.xml vs. phpdoc.dist.xml =====
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. 

===== Links =====
  * [[https://www.phpdoc.org/|Homepage]]