Classes, interfaces and traits

PhingPhpDocumentorErrorTracker

Phing subclass of the ErrorTracker class provided with PhpDocumentor to work around limitations in PhpDocumentor API.

This class is necessary because PhpDocumentor does directly output errors and warnings occured during testing for undocumented elements to stdout. This class is injected globally to force PhpDocumentor to use phing's logging mechanism. Obviously this is far from ideal, but there's also no solution given the inflexibility of the PhpDocumentor design.
« More »

PhpDocumentor2Task

PhpDocumentor2 Task (http://www.phpdoc.org) Based on the DocBlox Task

Use {@link Project#createTask} to register a new Task.
« More »

PhpDocumentor2Wrapper

Wrapper around PhpDocumentor2 (so we retain PHP 5.2 compatibility in the main task)

« More »

PhingPhpDocumentorSetup

Phing subclass of the phpDocumentor_setup class provided with PhpDocumentor to work around limitations in PhpDocumentor API.

This class is necessary because phpDocumentor_setup does not expose a complete API for setting configuration options. Because this class must directly modify some "private" GLOBAL(!) configuration variables, it is liable to break if the PhpDocumentor internal implementation changes. Obviously this is far from ideal, but there's also no solution given the inflexibility of the PhpDocumentor design.
« More »

PhpDocumentorTask

Task to run PhpDocumentor.

Use {@link Project#createTask} to register a new Task.
« More »

PhpDocumentorExternalTask

Task to run phpDocumentor with an external process

This classes uses the commandline phpdoc script to build documentation. Use this task instead of the PhpDocumentorTask when you've a clash with the Smarty libraries.
« More »