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.
Use Composer to install this library:
$ composer require scaleupstack/annotations
This library is not yet documented. But perhaps scaleupstack/metadata can be helpful to find out how to use it.
TODO: to be done
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
@varare 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.
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.
Please check LICENSE.md in the root dir of this package.
ScaleUpVentures Gmbh, Germany
Thomas Nunninger thomas.nunninger@scaleupventures.com
www.scaleupventures.com