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

Reviewing the code and updating the documentation #4

Open
Hachitus opened this issue Sep 3, 2016 · 0 comments
Open

Reviewing the code and updating the documentation #4

Hachitus opened this issue Sep 3, 2016 · 0 comments

Comments

@Hachitus
Copy link
Owner

Hachitus commented Sep 3, 2016

Basically just go through the code and review the API on bigger level. At the same time update documentation and pick up things that could be changed in the upcoming milestones, so the API is will be more consistent, usable and makes sense. Currently the documentation at least, is a bit out-of-date. The biggest benefit is So we can see that the game engine is heading to correct path and that the documentation can be used.

Some suggestions regarding documentation:
Adding #crossLink, @required, @default, @event and @optional to documentation, where needed

@Hachitus Hachitus added this to the v0.5 milestone Sep 3, 2016
@Hachitus Hachitus modified the milestones: v0.6, v0.5 Sep 24, 2016
@Hachitus Hachitus modified the milestones: V0.8, v0.6 Oct 19, 2016
@Hachitus Hachitus modified the milestones: v0.9, V0.8 Oct 28, 2016
@Hachitus Hachitus removed this from the v0.9 milestone Nov 6, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant