For larger packages the doc generated "Index" section is most unhelpful.
See for example, the Go FLTK bindings.
There are two separate ways this could be improved:
For types with methods, show, e.g., "▶ type BmpImage" with no methods, unless the user clicks the triangle in which case it becomes "▼ type BmpImage" with all the methods shown (as now).
When there are more than some threshold number of functions (or methods) — say 7, where the first word is the same (e.g., func Draw(), func DrawArc(...), ..., func DrawYxLine3(...)), use the same technique as decribed above in 1.
These changes would make navigation much easier.
The text was updated successfully, but these errors were encountered:
Another example of nearly unusable documentation (because of the Index being far too long) is gotk3's documentation.
A lesser change that would help is to change the Alt+F search dialog (which incidentally, knocks out Alt+F access to the File menu), so that instead of listing everything, it just listed types and sections (e.g., consts, vars), thus making it a bit more useful.