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 document out of date/wrong #1773

Closed
buckle2000 opened this issue Mar 13, 2016 · 8 comments
Closed

API document out of date/wrong #1773

buckle2000 opened this issue Mar 13, 2016 · 8 comments

Comments

@buckle2000
Copy link
Contributor

Many apis are missing or wrong on http://api.haxeflixel.com/.
e.g. on http://api.haxeflixel.com/openfl/utils/index.html, there is no openfl.utils.Timer.
same for flash.*
These apis are supposed here as they are on http://api.openfl.org/.

@Gama11
Copy link
Member

Gama11 commented Mar 13, 2016

There's no openfl.utils.Timer on that page. Try clearing your cache (Shift+F5).

@dstrekelj
Copy link

@Gama11, I believe that was his point.

openfl.utils.Timer is present in the OpenFL API documentation, while it is missing from same package in the HaxeFlixel API documentation.

The "issue" appears to be that the API docs of HaxeFlixel dependencies (or, at the very least, OpenFL) are either outdated or improperly generated.

I find that all of the docs being in one place is a convenience, and not a necessity. However, if they are being included, then care must be taken to ensure they are correct.

@buckle2000
Copy link
Contributor Author

Yes, I was trying to express that. @dstrekelj thanks.

@buckle2000
Copy link
Contributor Author

Also, docs of flash.* are redundant, since they are almost the same as openfl.*.
By "almost", I mean that some (many) apis are only available on flash platform, but not yet implemented on other platforms in OpenFL.

@Gama11
Copy link
Member

Gama11 commented Mar 13, 2016

There isn't really much "maintaining" there, it's all generated.

@Gama11
Copy link
Member

Gama11 commented Mar 13, 2016

@buckle2000 You say there are "many" missing APIs. What else besides openfl.utils.Timer?

@buckle2000
Copy link
Contributor Author

@Gama11
e.g. 20+ new apis in openfl.display since the doc here was generated
just check (here)[http://api.openfl.org/] and compare the indexs on the left

@Gama11
Copy link
Member

Gama11 commented Mar 17, 2016

Moved to flixel-docs: HaxeFlixel/flixel-docs#160

@Gama11 Gama11 closed this as completed Mar 17, 2016
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