-
-
Notifications
You must be signed in to change notification settings - Fork 51
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Write usage manual #26
Comments
Sounds like a plan! |
I know a bit about https://github.com/nikic/PHP-Parser that is being used here and I get the idea that a reflection classes will be instantiated during PHP code parsing. But I have no clue how to give in a filename and get parsed reflections back from it. |
Technically speaking it is simple, you can instantiate a FileReflector object with the filename of the file that you want to process and it created an AST for you that you can consume |
I am using this lib in the API generator for the Yii Framework 2.0. You may check out the implementation here: https://github.com/yiisoft/yii2-apidoc/blob/master/models/Context.php#L57 |
Thanks. Besides for my needs I'm using Sami (https://github.com/fabpot/Sami) right now. What I plan to use this library for is https://github.com/php-annotations/php-annotations |
For version 2.0 (currently on the develop branch) there is a basic usage guide. I intend to add more documentation in the future but this solves the current issue |
Currently the
README.md
doesn't contain any usage instructions. Can you please add some examples?The text was updated successfully, but these errors were encountered: