public function StaticReflectionParser::getDocComment in Zircon Profile 8

Same name and namespace in other branches

1. 8.0 vendor/doctrine/common/lib/Doctrine/Common/Reflection/StaticReflectionParser.php \Doctrine\Common\Reflection\StaticReflectionParser::getDocComment()

Gets the doc comment.

Parameters

string $type The type: 'class', 'property' or 'method'.:

string $name The name of the property or method, not needed for 'class'.:

Return value

string The doc comment, empty string if none.

File

vendor/doctrine/common/lib/Doctrine/Common/Reflection/StaticReflectionParser.php, line 279

Class

StaticReflectionParser

Parses a file for namespaces/use/class declarations.

Namespace

Doctrine\Common\Reflection

Code

public function getDocComment($type = 'class', $name = '') {
  $this
    ->parse();
  return $name ? $this->docComment[$type][$name] : $this->docComment[$type];
}