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

API Documentation? #10

Open
bjadamson opened this issue Sep 4, 2016 · 0 comments
Open

API Documentation? #10

bjadamson opened this issue Sep 4, 2016 · 0 comments

Comments

@bjadamson
Copy link
Contributor

Hey, it would be great if there was documentation for the API, so it's easier to understand exactly what the API is.

The "data" proxy object is really neat, but it's API is really hidden. It's not obvious for example how to do various things in the library, such as iterating over all the entities. Trying to learn how to use this project so far has required me digging through the example (and following headers to learn what magical macros are doing for me)

Creating this issue to track the lack of documentation for the API. Even just pointers to the relative classes, indicating which are intended to be use as part of the public API would be massively helpful.

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

1 participant