TagConverter

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).

package

Default

Methods

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

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

Arguments

$child

\DOMElement

Export this tag to the given DocBlock.

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

Arguments

$parent

\DOMElement

Element to augment.

Response

\DOMElement

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

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

the version should not be prepended here but in templates; remove this.

Arguments

Response

string