$pathGenerator
$pathGenerator : \phpDocumentor\Transformer\Writer\PathGenerator
Sourcecode transformation writer; generates syntax highlighted source files in a destination's subfolder.
$pathGenerator : \phpDocumentor\Transformer\Writer\PathGenerator
checkRequirements() : void
This method verifies whether PHP has all requirements needed to run this writer.
If one of the requirements is missing for this Writer then an exception of type RequirementMissing should be thrown; this indicates to the calling process that this writer will not function.
When a requirements is missing stating which one.
transform(\phpDocumentor\Descriptor\ProjectDescriptor $project, \phpDocumentor\Transformer\Transformation $transformation) : void
This method writes every source code entry in the structure file to a highlighted file.
\phpDocumentor\Descriptor\ProjectDescriptor | $project | Document containing the structure. |
\phpDocumentor\Transformer\Transformation | $transformation | Transformation to execute. |