flixel-docs icon indicating copy to clipboard operation
flixel-docs copied to clipboard

API docs target dropdown

Open Gama11 opened this issue 9 years ago • 5 comments

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

Gama11 avatar Jun 30 '15 10:06 Gama11

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 avatar Jul 01 '15 20:07 Gama11

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.

Gama11 avatar Jan 24 '16 21:01 Gama11

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?

ashes999 avatar Apr 08 '16 21:04 ashes999

I don't think this is a dox issue.

Gama11 avatar Apr 08 '16 21:04 Gama11

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

ashes999 avatar Apr 10 '16 12:04 ashes999