Reference documentation and code samples for the Google Cloud PHP shared dependency, providing functionality useful to all components. Client class DescriptionFactory.
Creates a new Description object given a body of text.
Descriptions in phpDocumentor are somewhat complex entities as they can contain one or more tags inside their
body that can be replaced with a readable output. The replacing is done by passing a Formatter object to the
Description object's render method.
In addition to the above does a Description support two types of escape sequences:
@to escape the@character to prevent it from being interpreted as part of a tag, i.e.{@link}}to escape the}character, this can be used if you want to use the}character in the description of an inline tag.
If a body consists of multiple lines then this factory will also remove any superfluous whitespace at the beginning of each line while maintaining any indentation that is used. This will prevent formatting parsers from tripping over unexpected spaces as can be observed with tag descriptions.
Methods
__construct
Initializes this factory with the means to construct (inline) tags.
| Parameter | |
|---|---|
| Name | Description |
tagFactory |
phpDocumentor\Reflection\DocBlock\TagFactory
|
getTagFactory
create
Returns the parsed text of this description.
| Parameters | |
|---|---|
| Name | Description |
contents |
string
|
context |
?\phpDocumentor\Reflection\Types\Context
|