flixel-docs
flixel-docs copied to clipboard
API docs target dropdown
Currently we only have flash there, would be nice to have the remaining targets as well (html5, cpp, neko, android, ios...)
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)
Since https://github.com/HaxeFlixel/flixel/pull/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.
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?
I don't think this is a dox issue.
Is it worth digging down to the root cause to see if this is fixable?