https://github.com/scaleupstack/annotations
Annotations parser for classical DocBlock-style annotations and an extended multi-line declaration
https://github.com/scaleupstack/annotations
annotations docblock docblock-style metadata parser php php7 phpdoc phpdoc-parser phpdocumentor reflection
Last synced: 14 days ago
JSON representation
Annotations parser for classical DocBlock-style annotations and an extended multi-line declaration
- Host: GitHub
- URL: https://github.com/scaleupstack/annotations
- Owner: scaleupstack
- License: other
- Created: 2019-03-16T10:34:06.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-10-26T22:11:42.000Z (over 6 years ago)
- Last Synced: 2025-05-15T04:45:40.225Z (9 months ago)
- Topics: annotations, docblock, docblock-style, metadata, parser, php, php7, phpdoc, phpdoc-parser, phpdocumentor, reflection
- Language: PHP
- Size: 57.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ScaleUpStack/Annotations
## About
This library allows to read annotations in the classical DocBlock style including an extended multi-line declaration.
The built-in set of supported annotations can be extended easily by project-specific extensions.
## Installation
Use [Composer] to install this library:
```
$ composer require scaleupstack/annotations
```
## Introduction
This library is not yet documented. But perhaps [scaleupstack/metadata] can be helpful to find out how to use it.
TODO: to be done
## Current State
This library has been developed with a special intention in mind. It will evolve in the context of [scaleupstack/metadata], and [scaleupstack/easy-object].
This results in some known limitations that are no high-priority for this intended purpose.
* E.g. not all allowed class names in `@var` are supported (e.g. UTF-8 special chars).
* Only a sub-set of phpDocumentor annotation tags are built-in.
* Some limitations are perhaps very strict.
If you are missing anything, feel free to contact me, or create a pull request.
Currently these built-in annotations are implemented:
* `@method`
* `@property-read`
* `@var`
All other annotations are represented as `UnknownAnnotation`.
## Contribute
Thanks that you want to contribute to ScaleUpStack/Annotations.
* Report any bugs or issues on the [issue tracker].
* Get the source code from the [Git repository].
## License
Please check [LICENSE.md] in the root dir of this package.
## Copyright
ScaleUpVentures Gmbh, Germany
Thomas Nunninger
[www.scaleupventures.com]
[Composer]: https://getcomposer.org
[scaleupstack/metadata]: https://github.com/scaleupstack/metadata
[scaleupstack/easy-object]: https://github.com/scaleupstack/easy-object
[issue tracker]: https://github.com/scaleupstack/annotations/issues
[Git repository]: https://github.com/scaleupstack/annotations
[LICENSE.md]: LICENSE.md
[www.scaleupventures.com]: https://www.scaleupventures.com/