phpDocumentor

DescriptionDescriptor
in package

Table of Contents

$description  : Description
$inlineTags  : array<int, \phpDocumentor\Descriptor\TagDescriptor|null>
__construct()  : mixed
__toString()  : string
Renders docblock as string.
getBodyTemplate()  : string
getTags()  : array<int, \phpDocumentor\Descriptor\TagDescriptor|null>
Returns the tags for this description
isEmpty()  : bool
replaceTag()  : void

Properties

Methods

__construct()

public __construct(Description|null $description, array<int, \phpDocumentor\Descriptor\TagDescriptor|null> $inlineTags) : mixed
Parameters
$description : Description|null
$inlineTags : array<int, \phpDocumentor\Descriptor\TagDescriptor|null>
Return values
mixed

__toString()

Renders docblock as string.

public __toString() : string

This method is here for legacy purpose. The new v3 template has improved the way we render descriptons which requires more advanced handling of descriptions and just not some string jugling.

Tags
deprecated

will be removed in v4

Return values
string

getTags()

Returns the tags for this description

public getTags() : array<int, \phpDocumentor\Descriptor\TagDescriptor|null>
Return values
array<int, \phpDocumentor\Descriptor\TagDescriptor|null>

Search results