PHPFUI/InstaDoc

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.

CloneableInstantiable

Public
Private

Methods

public __construct(phpDocumentor\Reflection\DocBlock\TagFactory $tagFactory)

Initializes this factory with the means to construct (inline) tags.

public create(string $contents, ?phpDocumentor\Reflection\Types\Context $context = NULL) : phpDocumentor\Reflection\DocBlock\Description

Returns the parsed text of this description.

Properties

private $tagFactory = NULL

var \TagFactory

Methods

private lex(string $contents) : array

Strips the contents from superfluous whitespace and splits the description into a series of tokens.

return string[] A series of tokens of which the description text is composed.

private removeSuperfluousStartingWhitespace(string $contents) : string

Removes the superfluous from a multi-line description.

When a description has more than one line then it can happen that the second and subsequent lines have an
additional indentation. This is commonly in use with tags like this:

@since 1.1.0 This is an example
    description where we have an
    indentation in the second and
    subsequent lines.

If we do not normalize the indentation then we have superfluous whitespace on the second and subsequent
lines and this may cause rendering issues when, for example, using a Markdown converter.