DocTag

MMO\doc\helpers · 1 symbol · generated 30 Sep 2026

class

class MMO\doc\helpers\DocTag extends MMO\doc\helpers\DocComment

readonly

readonly bool $inline

readonly

readonly string $name

function add(string $text): void

$text	string
returns	void

protected function parseInlineTags(string $text): void

$text	string
returns	void

function render(array $opts = []): string

$opts = []	array
returns	string

function __construct(string $name, string $text = '', bool $inline = false)

Inherited members (22)

	Properties	Declared by	Description
	`content`	DocComment
	`texts`	DocComment

Methods	Declared by	Description
`addText($text)`	DocComment
`clear()`	DocComment	Empty the underlying content, keeping the object itself.
`count()`	DocComment	\Countable::count
`Description($text, $includeSummary)`	DocComment
`getDescription($includeSummary)`	DocComment
`getIterator()`	DocComment	\IteratorAggregate::getIterator
`getParam($name)`	DocComment
`getSummary()`	DocComment
`getTexts()`	DocComment
`isEmpty()`	DocComment
`jsonSerialize()`	DocComment	\JsonSerializable::jsonSerialize -- the raw content is returned as-is (not recursively converted), so json_encode() relies on any nested iArray values being JsonSerializable themselves.
`keys()`	DocComment
`loadArray($data)`	DocComment	Load every entry of a plain array into the content, through `offsetSet` (so any offsetSet() override defined by the class using this trait, e.g.
`offsetExists($key)`	DocComment	\ArrayAccess::offsetExists
`offsetGet($key)`	DocComment	\ArrayAccess::offsetGet
`offsetSet($key, $value)`	DocComment	\ArrayAccess::offsetSet -- a null $key appends (`$bag[] = $value`), like a plain PHP array.
`offsetUnset($key)`	DocComment	\ArrayAccess::offsetUnset -- on a list (sequential integer keys, as produced by `$bag[] = ...`), the element is spliced out (closing the gap and reindexing), matching \unset() semantics on a plain …
`Summary($text)`	DocComment
`toArray()`	DocComment	Convert the content to a plain array, recursively converting any nested `iArray` value (e.g.
`__toString()`	DocComment