HaxeFoundation / HaxeFoundation/dox

Need skimmable index per class

Open
#282 4 comments 1 reaction 0 assignees View on GitHub
Dominant language
Haxe
Stars
158
Forks
38
PR merge metrics
No merged PRs in 30d

Description

I'm new to Haxe (and it's related projects) so I've been using the output of this tool extensively! All of these pages desperately need an index of all properties/methods. It is _very_ hard to browse classes and get a sense of what they do.

Like here, what kind of things can you do with an [array](https://api.haxe.org/Array.html)?
Or on Haxe Flixel, what's covered by their [Math ](https://api.haxe.org/Array.html)utilities?
You have to wade through all the hairy details! I just want to skim for what looks familiar or new.

Most API docs present information like this, but see Qt for one of many examples:
https://doc.qt.io/qt-5/qaction.html
You just skim this index to see if you're in the right place than click the method that looks ballpark and start reading descriptions.

Another great thing on the Qt docs is the "[List of all members, including inherited members](https://doc.qt.io/qt-5/qaction-members.html)" link for any class.

Thanks for considering!

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.