Mapbox-gl-native: Outline classes in API reference

[1ec5]

The jazzy-generated API reference starts out with a front page that describes the SDK, along with detailed release notes, but there isn’t a high-level overview of classes to give the developer a lay of the land. The front page – or a “front matter” jazzy guide – should outline the major classes and their relationships, analogous to the _Propædia_ in the _Encyclopædia Britannica_. It would draw from existing class documentation comments, which already seek to draw connections between disparate classes, for example:

https://github.com/mapbox/mapbox-gl-native/blob/37e47e2f10e4c04d48e62665dd70c092dee4762a/platform/darwin/src/MGLMapSnapshotter.h#L128-L130
https://github.com/mapbox/mapbox-gl-native/blob/37e47e2f10e4c04d48e62665dd70c092dee4762a/platform/darwin/src/MGLPolyline.h#L18-L27

/cc @captainbarbosa @colleenmcginnis @jmkiley

[friedbunny]

This would be a huge help to developers looking to understand the class relationships in our SDK. Jazzy isn’t good at this out-of-the-box and we have a relatively large number of classes/methods/etc, so we can’t rely on the sidebar sections alone to provide adequate guidance.

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[friedbunny]

/cc @riastrad

[stale[bot]]

This issue has been automatically detected as stale because it has not had recent activity and will be archived. Thank you for your contributions.