PhpDocumentor task

2018, Jan 01 One min read

PhpDocumentor task

Description

Task to process phpdoc (see: www.phpdoc.org/). PhpDocumentor v3.0.0-alpha1 is embedded within ant4x.jar (see: github.com/phpDocumentor).

Installation

If you get error message : phpDocumentor.EMERGENCY: phpDocumentor detected that a requirement is missing in your system setup: The XSL writer was unable to find your XSLTProcessor; please check if you have installed the PHP XSL extension or XSLCache extension [] [] Please install (linux debian): $ apt-get install php5-xsl

PhpDocumentor task parameters

Attribute	Description	Value	Required
target	Path where to store the generated output		yes
directory	Comma-separated list of directories to (recursively) parse (multiple values allowed)		yes

Examples

/!\ php must be installed on the system and set up in the PATH.

<project name="phpdoc task"> 

  <taskdef name="phpdoc" 
       classname="net.sourceforge.ant4x.taskdefs.php.PhpDocumentorTask" 
       classpath="PATH/TO/ant4x.jar"/> 

  <target name="phpdoc"> 
    <phpdoc target="api" directory="dir1,dir2" />
  </target> 

</project>