phpDocumentor
Back to top  

Behaviour that adds support for the @method tag

category phpDocumentor
package Transformer
subpackage Behaviours
author Mike van Riel
copyright 2010-2011 Mike van Riel / Naenius. (http://www.naenius.com)
license MIT
link http://phpdoc.org

 Methods

Dispatches a logging request to log a debug message.

debug(string $message) : void
Inherited
inherited_from \phpDocumentor\Transformer\TransformerAbstract::debug()
inherited_from \phpDocumentor\Transformer\Behaviour\BehaviourAbstract::debug()
inherited_from \phpDocumentor\Plugin\Core\Transformer\Behaviour\Tag\ParamTag::debug()

Parameters

$message

string

The message to log.

Returns the transformer that hosts this behaviour.

getTransformer() : \phpDocumentor\Transformer\Transformer
Inherited
inherited_from \phpDocumentor\Transformer\Behaviour\BehaviourAbstract::getTransformer()
inherited_from \phpDocumentor\Plugin\Core\Transformer\Behaviour\Tag\ParamTag::getTransformer()

Returns

\phpDocumentor\Transformer\Transformer

Dispatches a logging request.

log(string $message, int $priority) : void
Inherited
inherited_from \phpDocumentor\Transformer\TransformerAbstract::log()
inherited_from \phpDocumentor\Transformer\Behaviour\BehaviourAbstract::log()
inherited_from \phpDocumentor\Plugin\Core\Transformer\Behaviour\Tag\ParamTag::log()

Parameters

$message

string

The message to log.

$priority

int

The logging priority, the lower, the more important. Ranges from 1 to 7

Find all the param tags and if using special characters transform using markdown otherwise just add a <p> tag to be consistent.

process(\DOMDocument $xml) : \DOMDocument
Inherited
inherited_from \phpDocumentor\Plugin\Core\Transformer\Behaviour\Tag\ParamTag::process()

Parameters

$xml

\DOMDocument

Structure source to apply behaviour onto.

Returns

\DOMDocument

Sets the transformer used for this behaviour.

setTransformer(\phpDocumentor\Transformer\Transformer $transformer) : void
Inherited
inherited_from \phpDocumentor\Transformer\Behaviour\BehaviourAbstract::setTransformer()
inherited_from \phpDocumentor\Plugin\Core\Transformer\Behaviour\Tag\ParamTag::setTransformer()

Parameters

$transformer

\phpDocumentor\Transformer\Transformer

Transformer responsible for output.

 Properties

 

Make element name overrideable.

$element_name : string
 

$transformer : \phpDocumentor\Transformer\Transformer
Inherited
inherited_from \phpDocumentor\Transformer\Behaviour\BehaviourAbstract::$$transformer
inherited_from \phpDocumentor\Plugin\Core\Transformer\Behaviour\Tag\ParamTag::$$transformer