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 docs target dropdown #132

Open
Gama11 opened this issue Jun 30, 2015 · 5 comments
Open

API docs target dropdown #132

Gama11 opened this issue Jun 30, 2015 · 5 comments

Comments

@Gama11
Copy link
Member

Gama11 commented Jun 30, 2015

Currently we only have flash there, would be nice to have the remaining targets as well (html5, cpp, neko, android, ios...)

@Gama11
Copy link
Member Author

Gama11 commented Jul 1, 2015

Generating the xml files works fine, but dox has some issues with them when trying to generate the docs:

Parsing ./flash.xml
Parsing ./neko.xml
Called from ? line 1
Called from dox/Dox.hx line 137
Called from dox/Dox.hx line 130
Called from C:\HaxeToolkit\haxe\std/haxe/rtti/XmlParser.hx line 84
Called from C:\HaxeToolkit\haxe\std/haxe/rtti/XmlParser.hx line 311
Called from C:\HaxeToolkit\haxe\std/haxe/rtti/XmlParser.hx line 278
Uncaught exception - Incompatibilities between UInt in flash and neko (documenta
tion is different)

@Gama11
Copy link
Member Author

Gama11 commented Jan 24, 2016

Since HaxeFlixel/flixel#1668, there really isn't all that much API that exclusively exists on a specific target, so this is probably not worth the time investment.

@ashes999
Copy link
Contributor

ashes999 commented Apr 8, 2016

This is interesting. I was going to suggest (since the issue I ran into is "field missing in docs") pick a target that has the most fields/methods and publish those, instead. (You can use XML size as a rough gauge of this.)

Is it worth pursuing this?

Should we see if the (downstream) exception can be fixed in Dox?

@Gama11
Copy link
Member Author

Gama11 commented Apr 8, 2016

I don't think this is a dox issue.

@ashes999
Copy link
Contributor

Is it worth digging down to the root cause to see if this is fixable?

@Gama11 Gama11 added the api label Sep 29, 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

2 participants