public function StaticReflectionParser::getDocComment

Get docComment.

Parameters

string $type class, property or method.:

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

Return value

string the doc comment or empty string if none.

File

drupal/core/vendor/doctrine/common/lib/Doctrine/Common/Reflection/StaticReflectionParser.php, line 256

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];
}