\phpDocumentor\Plugin\Core\Transformer\WriterSourcecode

Sourcecode transformation writer; generates syntax highlighted source files in a destination's subfolder.

Summary

Methods
Properties
Constants
checkRequirements()
transform()
No public properties found
No constants found
checkForSpacesInPath()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

checkRequirements()

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.

Throws

\phpDocumentor\Transformer\Writer\Exception\RequirementMissing

when a requirements is missing stating which one.

checkForSpacesInPath()

checkForSpacesInPath(string  $path) : void

Checks if there is a space in the path.

Parameters

string $path

Throws

\InvalidArgumentException

if path contains a space.