HSA Test User c16dcac362 User import | 7 lat temu | |
---|---|---|
.. | ||
src | 7 lat temu | |
.gitignore | 7 lat temu | |
.travis.yml | 7 lat temu | |
LICENSE | 7 lat temu | |
README.md | 7 lat temu | |
composer.json | 7 lat temu | |
composer.lock | 7 lat temu | |
phpunit.xml.dist | 7 lat temu |
The ReflectionDocBlock component of phpDocumentor provides a DocBlock parser that is 100% compatible with the PHPDoc standard.
With this component, a library can provide support for annotations via DocBlocks or otherwise retrieve information that is embedded in a DocBlock.
Note: this is a core component of phpDocumentor and is constantly being optimized for performance.
You can install the component in the following ways:
The ReflectionDocBlock component is designed to work in an identical fashion to PHP's own Reflection extension (http://php.net/manual/en/book.reflection.php).
Parsing can be initiated by instantiating the
\phpDocumentor\Reflection\DocBlock()
class and passing it a string containing
a DocBlock (including asterisks) or by passing an object supporting the
getDocComment()
method.
Examples of objects having the
getDocComment()
method are theReflectionClass
and theReflectionMethod
classes of the PHP Reflection extension
Example:
$class = new ReflectionClass('MyClass');
$phpdoc = new \phpDocumentor\Reflection\DocBlock($class);
or
$docblock = <<<DOCBLOCK
/**
* This is a short description.
*
* This is a *long* description.
*
* @return void
*/
DOCBLOCK;
$phpdoc = new \phpDocumentor\Reflection\DocBlock($docblock);