\phpDocumentor\Plugin\Core\Transformer\Writer\XmlTagConverter

Creates an XML Element 'tag' and appends it to the provided parent element.

With this class we convert a TagDescriptor, or any child thereof, into an XML element that is subsequently appended onto a provided parent element (usually an XML Element that represents a DocBlock).

During the conversion process the generated XML Element is enriched with additional elements and attributes based on which tags are provided (or more specifically which methods that support).

Summary

Methods
Properties
Constants
convert()
No public properties found
No constants found
getDescription()
addTypes()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

convert()

convert(\DOMElement  $parent, \phpDocumentor\Descriptor\TagDescriptor  $tag) : \DOMElement

Export this tag to the given DocBlock.

Parameters

\DOMElement $parent

Element to augment.

\phpDocumentor\Descriptor\TagDescriptor $tag

The tag to export.

Returns

\DOMElement

getDescription()

getDescription(\phpDocumentor\Descriptor\TagDescriptor  $tag) : string

Returns the description from the Tag with the version prepended when applicable.

Parameters

\phpDocumentor\Descriptor\TagDescriptor $tag

Returns

string

addTypes()

addTypes(\phpDocumentor\Descriptor\TagDescriptor  $tag, \DOMElement  $child) : void

Adds type elements and a type attribute to the tag if a method 'getTypes' is present.

Parameters

\phpDocumentor\Descriptor\TagDescriptor $tag
\DOMElement $child