DocBlockConverter

Converter used to create an XML Element representing a DocBlock and its tags.

In order to convert the tags to their XML representation this class requires the respective converter.

package

Default

Methods

Stores the converter for tags on this converter.

__construct(\phpDocumentor\Plugin\Core\Transformer\Writer\Xml\TagConverter $tagConverter, \phpDocumentor\Transformer\Router\RouterAbstract $router) 

Adds the DocBlock's long description to the $child element,

addDescription(\DOMElement $node, \phpDocumentor\Descriptor\DescriptorAbstract $element) : void

Arguments

$node

\DOMElement

Adds the 'inherited_from' tag when a Descriptor inherits from another Descriptor.

addInheritedFromTag(\DOMElement $docBlock, \phpDocumentor\Descriptor\DescriptorAbstract $descriptor) : void

Arguments

$docBlock

\DOMElement

Adds the short description of $docblock to the given node as description field.

addSummary(\DOMElement $node, \phpDocumentor\Descriptor\DescriptorAbstract $element) : void

Arguments

$node

\DOMElement

Adds each tag to the XML Node representing the DocBlock.

addTags(\DOMElement $docBlock, \phpDocumentor\Descriptor\DescriptorAbstract $descriptor) : void

The Descriptor contains an array of tag groups (that are tags grouped by their name), which in itself contains an array of the individual tags.

Arguments

$docBlock

\DOMElement

Exports the given reflection object to the parent XML element.

convert(\DOMElement $parent, \phpDocumentor\Descriptor\DescriptorAbstract $element) : \DOMElement

This method creates a new child element on the given parent XML element and takes the properties of the Reflection argument and sets the elements and attributes on the child.

If a child DOMElement is provided then the properties and attributes are set on this but the child element is not appended onto the parent. This is the responsibility of the invoker. Essentially this means that the $parent argument is ignored in this case.

Arguments

$parent

\DOMElement

The parent element to augment.

Response

\DOMElement

Properties

Converter used to generate XML elements from TagDescriptors

tagConverter : \phpDocumentor\Plugin\Core\Transformer\Writer\Xml\TagConverter
var

Converter used to generate XML elements from TagDescriptors

Type(s)

\phpDocumentor\Plugin\Core\Transformer\Writer\Xml\TagConverter

router

router : \phpDocumentor\Transformer\Router\RouterAbstract