Classes, interfaces and traits

Debug

This class is responsible for sending statistical information to the log.

For debugging purposes it can be convenient to send statistical information about the ProjectDescriptor to the log of phpDocumentor.

« More »

ElementsIndexBuilder

This class constructs the index 'elements' and populates it with all Structural Elements.

Please note that due to a conflict between namespace FQSEN's and that of classes, interfaces, traits and functions will the namespace FQSEN be prefixed with a tilde (~).

« More »

ExampleTagsEnricher

This index builder collects all examples from tags and inserts them into the example index.

« More »

MarkerFromTagsExtractor

This index builder collects all markers from tags and inserts them into the marker index.

« More »

NamespaceTreeBuilder

Rebuilds the namespace tree from the elements found in files.

On every compiler pass is the namespace tree rebuild to aid in the process of incremental updates. The Files Collection in the Project Descriptor is the only location where aliases to elements may be serialized.

If the namespace tree were to be persisted then both locations needed to be invalidated if a file were to change.

« More »

PackageTreeBuilder

Rebuilds the package tree from the elements found in files.

On every compiler pass is the package tree rebuild to aid in the process of incremental updates.

If the package tree were to be persisted then both locations needed to be invalidated if a file were to change.

« More »

ResolveInlineLinkAndSeeTags

This step in the compilation process iterates through all elements and scans their descriptions for an inline `@see` or `@link` tag and resolves them to a markdown link.

« More »