Skip to content
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

Closed
aik099 opened this issue Jul 19, 2014 · 6 comments
Closed

Write usage manual #26

aik099 opened this issue Jul 19, 2014 · 6 comments

Comments

@aik099
Copy link

aik099 commented Jul 19, 2014

Currently the README.md doesn't contain any usage instructions. Can you please add some examples?

@mvriel
Copy link
Member

mvriel commented Jul 19, 2014

Sounds like a plan!

@aik099
Copy link
Author

aik099 commented Jul 19, 2014

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.

@mvriel
Copy link
Member

mvriel commented Jul 19, 2014

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

@cebe
Copy link
Contributor

cebe commented Jul 19, 2014

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

@aik099
Copy link
Author

aik099 commented Jul 19, 2014

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

@mvriel
Copy link
Member

mvriel commented Nov 21, 2014

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

@mvriel mvriel closed this as completed Nov 21, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants