|
1 | | -# Jasny PHPDoc parser |
| 1 | +<p align="center"><a href="https://t-regx.com/"><img src="t.regx.png"></a></p> |
2 | 2 |
|
3 | | -[](https://github.com/jasny/phpdoc-parser/actions/workflows/php.yml) |
4 | | -[](https://scrutinizer-ci.com/g/jasny/phpdoc-parser/?branch=master) |
5 | | -[](https://scrutinizer-ci.com/g/jasny/phpdoc-parser/?branch=master) |
6 | | -[](https://packagist.org/packages/jasny/phpdoc-parser) |
7 | | -[](https://packagist.org/packages/jasny/phpdoc-parser) |
| 3 | +# PhpDoc parser |
8 | 4 |
|
9 | | -Configurable DocBlock parser from PHP. |
| 5 | +Lightweight parser of PhpDoc. |
10 | 6 |
|
11 | | -Annotations aren't implemented in PHP itself which is why this component offers a way to use the PHP doc-blocks as a |
12 | | -place for the well known tag syntax using the `@` char. |
| 7 | +[](https://github.com/T-Regx/phpdoc-parser/actions/) |
| 8 | +[](https://coveralls.io/github/T-Regx/phpdoc-parser?branch=master) |
| 9 | +[](https://github.com/T-Regx/phpdoc-parser) |
| 10 | +[](https://github.com/T-Regx/phpdoc-parser/blob/master/LICENSE) |
| 11 | +[](https://github.com/T-Regx/phpdoc-parser) |
13 | 12 |
|
14 | | -The PHPDoc parser allows you to configure tags including the method how to parse and extract information. This |
15 | | -is inline with phpDocumentor style annotations and differs from for instance Doctrine type annotations. |
| 13 | +[][1] |
| 14 | +[][1] |
| 15 | +[][1] |
| 16 | +[][1] |
| 17 | +[][1] |
| 18 | +[][1] |
16 | 19 |
|
17 | | -## Installation |
| 20 | +[1]: https://github.com/T-Regx/phpdoc-parser/runs/2375602376 |
| 21 | + |
| 22 | +[](http://makeapullrequest.com) |
| 23 | + |
| 24 | +1. [Installation](#installation) |
| 25 | + * [Composer](#installation) |
| 26 | +2. [Usage](#usage) |
| 27 | +3. [Tags](#tags) |
| 28 | +4. [Tag classes](#tag-classes) |
| 29 | +5. [FQSEN Resolve](#fqsen-resolver) |
| 30 | +6. [Current limitations](#current-limitations) |
| 31 | +7. [Fixed from the original](#fixed-from-the-original) |
| 32 | + |
| 33 | +# Installation |
| 34 | + |
| 35 | +Installation for PHP 7.1 and later: |
18 | 36 |
|
19 | 37 | ```bash |
20 | | -composer require jasny/phpdoc-parser |
| 38 | +composer require rawr/phpdoc-parser |
21 | 39 | ``` |
22 | 40 |
|
23 | 41 | ## Usage |
|
0 commit comments