ofSite
ofSite copied to clipboard
method and function grouping
getWidth() and getHeight() should be next to each other, and some methods should be presented in a way that shows they're less "important" than others (or that they're lower level than others).
I'm not sure that contextual sorting is better than alphabetical—it might help with browsing, but it might also make it harder to find something that you're looking for. Maybe a better option is to add a "Related Methods" section to each method?
Either way, you're hand-curating these things, both for importance and ordering.
maybe @ofZach could chime in and explain better what he meant -- i was adding this issue for him :)
A small improvement would be if constructors were always the first items of classes, instead of being alphabetized with the rest of the functions. Not sure if oF uses static methods anywhere, but those probably should too be grouped together. Operators could also possibly be grouped together.
I think Qt has fairly nice documentation pages, a random example: QList. Note the grouping there: constructors first, then destructor, regular member functions, and member operators. Static member functions are also clearly in their own group.