phpDocumentor

Sourcecode extends WriterAbstract
in package

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

Table of Contents

$pathGenerator  : PathGenerator
__construct()  : mixed
__toString()  : string
checkRequirements()  : void
This method verifies whether PHP has all requirements needed to run this writer.
transform()  : void
This method writes every source code entry in the structure file to a highlighted file.

Properties

Methods

__toString()

public __toString() : string
Return values
string

checkRequirements()

This method verifies whether PHP has all requirements needed to run this writer.

public checkRequirements() : void

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.

Tags
throws
RequirementMissing

When a requirements is missing stating which one.

codeCoverageIgnore
Return values
void

Search results