phpDocumentor
Back to top  

Classes and interfaces

Exception

Base exception for plugins.

« More »

ListenerAbstract

Base class for plugin event listeners.

« More »

Manager

This class loads the plugins from the configuration and initializes them.

« More »

Plugin

This class represents a single plugin with all it's options and properties.

« More »

PluginAbstract

Layer superclass for the Plugin Component; contains all event dispatching code.

« More »

Classes and interfaces

Exception

Exception object for the Core Plugin.

« More »

Listener

Listener for the Core Plugin.

« More »

Log

Struct to hold severity levels when logging.

« More »
This namespace does not contain any documentable elements
This namespace does not contain any documentable elements
This namespace does not contain any documentable elements

Classes and interfaces

Covers

Definition for the @covers tag; expands the class mentioned in the refers attribute.

« More »

Definition

Generic Definition which adds the basic tag information to the structure file.

« More »

Doctrine

Definition for all Doctrine tags to explode them into subcomponents so they can be better processed in the transformation.

« More »

Legacy

Definition for tags that despite having their own descriptions in the reflection (different from the content as a whole), need to be exported as if they didn't, in order to maintain backwards compatibility.

« More »

Method

Definition for the @param tag; adds a attribute called `variable`.

« More »

Param

Definition for the @param tag; adds a attribute called `variable`.

« More »

See

Definition for the @see tag; expands the class mentioned in the refers attribute.

« More »

Uses

Definition for the @uses tag; expands the class mentioned in the refers attribute.

« More »

Classes and interfaces

ClassValidator

This class is responsible for validating the class docbloc

« More »

DeprecatedValidator

This class is responsible for validating which tags are deprecated as defined in /src/phpDocumentor/Plugin/Core/plugin.xml

« More »

FileValidator

This class is responsible for validating the file docbloc

« More »

FunctionValidator

This class is responsible for validating a function's docblock.

« More »

MethodValidator

This class is responsible for validating the method doc block

« More »

PropertyValidator

This class is responsible for validating a properties docblock.

« More »

RequiredValidator

This class is responsible for validating which tags are required as defined in /src/phpDocumentor/Plugin/Core/plugin.xml

« More »

ValidatorAbstract

Base class for DocBlock Validations.

« More »
This namespace does not contain any documentable elements

Classes and interfaces

AddLinkInformation

Behaviour that adds generated path information on the File elements.

« More »

GeneratePaths

Behaviour that adds generated path information on the File elements.

« More »

Inherit

Behaviour that runs through all elements and inherit base information when necessary.

« More »
This namespace does not contain any documentable elements

Classes and interfaces

ClassNode

Responsible for adding inheritance behaviour to an individual class.

« More »

ConstantNode

Responsible for adding inheritance behaviour to an individual constant.

« More »

DocBlockNode

Wrapper class around a DOMElement containing a DocBlock definition.

« More »

MethodNode

Responsible for adding inheritance behaviour to an individual method.

« More »

NodeAbstract

Base class for adding inheritance to an element.

« More »

PropertyNode

Responsible for adding inheritance behaviour to an individual property.

« More »

Classes and interfaces

AuthorTag

Behaviour that links to email addresses in the @author tag.

« More »

CoversTag

Behaviour that adds support for the @covers tag

« More »

IgnoreTag

Behaviour that adds support for @ignore tag.

« More »

InternalTag

Behaviour that adds support for @internal tag.

« More »

LicenseTag

Behaviour that enables links to URLs in the @license tag.

« More »

MethodTag

Behaviour that adds support for the @method tag

« More »

ParamTag

Behaviour that adds support for the @param tags.

« More »

PropertyTag

Behaviour that adds support for the property tag

« More »

ReturnTag

Behaviour that adds support for the return tag

« More »

UsesTag

Behaviour that adds support for the uses tag

« More »

VarTag

Behaviour that adds support for the @method tag

« More »

Classes and interfaces

Checkstyle

Checkstyle transformation writer; generates checkstyle report

« More »

FileIo

Writer containing file system operations.

« More »

Graph

Class diagram generator.

« More »

Pdf

A PDF writer which uses wkhtmltopdf to convert a single HTML file to PDF.

« More »

Sourcecode

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

« More »

Xsl

XSL transformation writer; generates static HTML out of the structure and XSL templates.

« More »