phpDocumentor
\
phpDocumentor
Compiler
Linker
Pass
Configuration
Definition
Exception
Console
Command
Project
DependencyInjection
Descriptor
Builder
Reflector
Docblock
Tags
Cache
DocBlock
Exception
Filter
Interfaces
ProjectDescriptor
TableOfContents
Tag
BaseTypes
Validation
Event
Guides
Handlers
Parser
Cache
Event
Exception
Middleware
Pipeline
Stage
Cache
Parser
Transformer
Event
Router
Template
Writer
Exception
Graph
Twig

\phpDocumentor\Descriptor\DocBlockDescriptionDescriptor

Summary

Methods
Properties
Constants
__construct()
getBodyTemplate()
replaceTag()
getTags()
isEmpty()
__toString()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$description
$inlineTags
N/A

Properties

$description

$description : \phpDocumentor\Reflection\DocBlock\Description

Type

\phpDocumentor\Reflection\DocBlock\Description —

$inlineTags

$inlineTags : array<int,\phpDocumentor\Descriptor\TagDescriptor|null>

Type

TagDescriptor|null> —

Methods

__construct()

__construct(?\phpDocumentor\Reflection\DocBlock\Description  $description, array<int,\phpDocumentor\Descriptor\TagDescriptor|null>  $inlineTags) : mixed

Parameters

?\phpDocumentor\Reflection\DocBlock\Description $description
array $inlineTags

Returns

mixed —

getBodyTemplate()

getBodyTemplate() : string

Returns

string —

replaceTag()

replaceTag(int  $position, ?\phpDocumentor\Descriptor\TagDescriptor  $tagDescriptor) : void

Parameters

int $position
?\phpDocumentor\Descriptor\TagDescriptor $tagDescriptor

getTags()

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

Returns the tags for this description

Returns

array —

isEmpty()

isEmpty() : bool

Returns

bool —

__toString()

__toString() : string

Renders docblock as 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.

Returns

string —