TagInterface

namespace	bhenk\doc2rst\tag
predicates	Abstract | Interface
known implementations	AbstractLinkTag | AbstractSimpleTag | AbstractTag | AbstractTypeTag | AbstractVersionTag | ApiTag | AuthorTag | CopyrightTag | DeprecatedTag | GeneratedTag | InheritdocTag | InternalTag | LicenseTag | LinkTag | PackageTag | ParamTag | ReturnTag | SeeTag | SinceTag | ThrowsTag | TodoTag | UsesTag | VarTag | VersionTag

---

Methods

TagInterface::toRst

predicates

public | abstract

Express this Tag in reStructuredText

public abstract function toRst(): string

return string - reStructuredText representation of this Tag

---

TagInterface::getTagName

predicates

public | abstract

Gets the tag-name of this Tag

public abstract function getTagName(): string

return string - tag-name of this Tag

---

TagInterface::getDisplayName

predicates

public | abstract

Get the short version of this tagname, without the at-sign (@)

public abstract function getDisplayName(): string

return string - short version of this tagname

---

TagInterface::isInline

predicates

public | abstract

Is this an inline tag

Is this an inline tag (with curly braces) or does this tag appear at the start of a line.

public abstract function isInline(): bool

return bool - true if this is an inline link, false otherwise

---

TagInterface::getTagLength

predicates

public | abstract

Get the length (in characters) of this tagname

public abstract function getTagLength(): int

return int - length (in characters) of this tagname

---

TagInterface::getGroupWidth

predicates

public | abstract

Get the width (in characters) of the group in which this Tag will be displayed

public abstract function getGroupWidth(): int

return int - width (in characters) or -1 if not yet set

---

TagInterface::setGroupWidth

predicates

public | abstract

Set the width (in characters) of the group in which this Tag will be displayed

public abstract function setGroupWidth(
      Parameter #0 [ <required> int $max_width ]
 ): void

param int $max_width - width (in characters)

return void

---

Fri, 31 Mar 2023 13:22:46 +0000