phpDocumentor\Reflection\DocBlock\Description::getFormattedContents PHP Method

getFormattedContents() public method

Return a formatted variant of the Long Description using MarkDown.
public getFormattedContents ( ) : string
return string
    public function getFormattedContents()
    {
        $result = $this->contents;
        // if the long description contains a plain HTML <code> element, surround
        // it with a pre element. Please note that we explicitly used str_replace
        // and not preg_replace to gain performance
        if (strpos($result, '<code>') !== false) {
            $result = str_replace(array('<code>', "<code>\r\n", "<code>\n", "<code>\r", '</code>'), array('<pre><code>', '<code>', '<code>', '<code>', '</code></pre>'), $result);
        }
        if (class_exists('dflydev\\markdown\\MarkdownExtraParser')) {
            $markdown = new \dflydev\markdown\MarkdownExtraParser();
            $result = $markdown->transformMarkdown($result);
        }
        return trim($result);
    }