phpdocumentor/reflection-docblock

With this component, a library can provide support for annotations via DocBlocks or otherwise retrieve information that is embedded in a DocBlock.

Wednesday, June 20, 2018
by mvriel
Repository
16 Watchers
3605 Stars
77,313,053 Installations

PHP
409 Dependents
13 Suggesters
61 Forks
3 Open issues
46 Versions
9 % Grown

The README.md

, _(*1)

ReflectionDocBlock

Introduction

The ReflectionDocBlock component of phpDocumentor provides a DocBlock parser that is 100% compatible with the PHPDoc standard., _(*2)

With this component, a library can provide support for annotations via DocBlocks or otherwise retrieve information that is embedded in a DocBlock., _(*3)

Installation

composer require phpdocumentor/reflection-docblock

Usage

In order to parse the DocBlock one needs a DocBlockFactory that can be instantiated using its createInstance factory method like this:, _(*4)

$factory  = \phpDocumentor\Reflection\DocBlockFactory::createInstance();

Then we can use the create method of the factory to interpret the DocBlock. Please note that it is also possible to provide a class that has the getDocComment() method, such as an object of type ReflectionClass, the create method will read that if it exists., _(*5)

$docComment = <<<DOCCOMMENT
/**
 * This is an example of a summary.
 *
 * This is a Description. A Summary and Description are separated by either
 * two subsequent newlines (thus a whiteline in between as can be seen in this
 * example), or when the Summary ends with a dot (`.`) and some form of
 * whitespace.
 */
DOCCOMMENT;

$docblock = $factory->create($docComment);

The create method will yield an object of type \phpDocumentor\Reflection\DocBlock whose methods can be queried:, _(*6)

// Contains the summary for this DocBlock
$summary = $docblock->getSummary();

// Contains \phpDocumentor\Reflection\DocBlock\Description object
$description = $docblock->getDescription();

// You can either cast it to string
$description = (string) $docblock->getDescription();

// Or use the render method to get a string representation of the Description.
$description = $docblock->getDescription()->render();

For more examples it would be best to review the scripts in the /examples folder., _(*7)

The Versions

20/06 2018

dev-master

9999999-dev

With this component, a library can provide support for annotations via DocBlocks or otherwise retrieve information that is embedded in a DocBlock.

library reflection-docblock

With this component, a library can provide support for annotations via DocBlocks or otherwise retrieve information that is embedded in a DocBlock.

phpdocumentor/reflection-docblock

The README.md

ReflectionDocBlock

Introduction

Installation

Usage

The Versions

dev-master

The Requires

The Development Requires

by Mike van Riel

5.0.0-alpha3

The Requires

The Development Requires

by Mike van Riel

5.0.0-alpha2

The Requires

The Development Requires

by Mike van Riel

5.0.0-alpha1

The Requires

The Development Requires

by Mike van Riel

4.3.0

The Requires

The Development Requires

by Mike van Riel

4.2.0

The Requires

The Development Requires

by Mike van Riel

dev-release/3.x

The Requires

The Development Requires

by Mike van Riel

3.3.2

The Requires

The Development Requires

by Mike van Riel

3.3.0

The Requires

The Development Requires

by Mike van Riel

4.1.1

The Requires

The Development Requires

by Mike van Riel

3.2.3

The Requires

The Development Requires

by Mike van Riel

4.1.0

The Requires

The Development Requires

by Mike van Riel

4.0.1

The Requires

The Development Requires

by Mike van Riel

3.2.2

The Requires

The Development Requires

by Mike van Riel

4.0.0

The Requires

The Development Requires

by Mike van Riel

3.2.1

The Requires

The Development Requires

by Mike van Riel

3.2.0

The Requires

The Development Requires

by Mike van Riel

dev-feature/bump-type-resolver

The Requires

The Development Requires