ApiGen\Parser\Reflection\ReflectionParameter::getDescription PHP Method

getDescription() public method

public getDescription ( )
    public function getDescription()
    {
        $annotations = $this->getDeclaringFunction()->getAnnotation('param');
        if (empty($annotations[$this->getPosition()])) {
            return '';
        }
        $description = trim(strpbrk($annotations[$this->getPosition()], "\n\r\t "));
        return preg_replace('~^(\\$' . $this->getName() . '(?:,\\.{3})?)(\\s+|$)~i', '\\2', $description, 1);
    }