Parses a Long Description of a DocBlock.

category phpDocumentor
package Reflection
author Mike van Riel
license MIT
link http://phpdoc.org

 Methods

Parses the string for inline tags and if the Markdown class is included; format the found text.

__construct(string $content) 

Parameters

$content

string

the DocBlock contents without asterisks.

Returns the exported information (we should use the export static method BUT this throws an exception at this point).

__toString() : void

Builds a string representation of this object.

export() : void

todo determine the exact format as used by PHP Reflection and implement it.

Returns the text of this description.

getContents() : string

Returns

string

Return a formatted variant of the Long Description using MarkDown.

getFormattedContents() : string

todo this should become a more intelligent piece of code where the configuration contains a setting what format long descriptions are.

Returns

string

Returns a list of tags mentioned in the text.

getTags() : \phpDocumentor_Reflection_DocBlock_Tags[]

Returns

\phpDocumentor_Reflection_DocBlock_Tags[]

 Properties

 

$contents

$contents : string

 

$tags

$tags : \phpDocumentor_Reflection_DocBlock_Tags[]