dox
dox copied to clipboard
HaxeFoundation
Haxe documentation generator.
Running dox on a class with an overloaded function, each version having its own documentation: ```haxe extern class Test { /** Test with String **/ static inline overload function test(s:String):Void...
Hi, I noticed that interface fields are duplicated on the class implementation, see for instance interface here: https://heaps.io/api/hxd/fs/FileSystem.html and implementation there: https://heaps.io/api/hxd/fs/BytesFileSystem.html I think we should only list the methods/vars...
Similar to "Inherited Variables" and "Inherited Methods", the end of each page should also include "Inherited Events" for the `@event` tag content from base classes. Basically, it'll be just as...
A couple of issues with dox stem from incorrect type and field resolution. (#252, #203, possibly also #241 and #184?). The current resolver for links (https://github.com/HaxeFoundation/dox/blob/master/src/dox/MarkdownHandler.hx#L45) could be smarter –...
In the macro API documentation [here](https://api.haxe.org/haxe/macro/ExprDef.html#EReturn), the EReturn ExprDef is stated as having an Expr parameter, but it accepts null, and with a null parameter it becomes a plain `return;`...
They should have their own entry in the navigation and their own pages that list all the types they contain. The trickiest part would probably be how to deal with...
Some targets don't deal well with optional arguments on dynamic calls, which means that https://github.com/HaxeFoundation/dox/commit/2230b4bed9fe37dd891693fe939b770c4c477842 caused a regression on those. This affects at least Java.
The "Goto type" of most IDEs allows "CamelCase" search, i.e. searching by the only the uppercase letters, which saves quite a bit of typing:  This would be handy here...
(This may be an issue for `api.haxe.org` specifically.) I would like the "View source" button for e.g. `sys.io.File` to be a dropdown menu showing these entries: - the core API...
https://api.haxe.org/cs/Int16.html "import cs.StdTypes" on this page links to a dead page, because it is some kind of collection without an actual StdTypes type member. Can we detect if this actually...
