debug::docComment PHP Method

docComment() public method

public docComment ( &$programElement )
    public function docComment(&$programElement)
    {
        $textTag =& $programElement->tags('@text');
        if ($textTag && $textTag->text($this)) {
            echo $this->showDepth(), '|= ', $textTag->text($this), "\n";
            foreach ($textTag->inlineTags($this) as $inlineTag) {
                if ($inlineTag->name() != '@text') {
                    echo $this->showDepth(), '|= ', $inlineTag->displayName(), ': ', $inlineTag->text($this), "\n";
                }
            }
        }
    }