diff options
| author | Minh Nguyễn <mxn@1ec5.org> | 2016-12-20 16:11:05 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-12-20 16:11:05 -0800 |
| commit | 1254bcdb4006d87fefedfc5020b3dc7d3cd0e544 (patch) | |
| tree | 8ee29bf1575993965c2040b1318fb70388a255a9 /platform/darwin/src/MGLStyle.h | |
| parent | a174588e6ccb5c0101479c882d399a07ba96ba76 (diff) | |
| download | qtlocation-mapboxgl-1254bcdb4006d87fefedfc5020b3dc7d3cd0e544.tar.gz | |
[ios, macos] Update and reformat documentation for runtime styling (#7475)
* [ios, macos] Optimized changelog for runtime styling
Changelog entries related to style JSON now lead off with the analogous portion of the runtime styling API.
* [ios, macos] Autolink cross-class property references in docs
jazzy can autolink `Class.property` references in documentation comments.
* [ios, macos] Removed extra blank lines
* [ios, macos] Corrected typo in MGLMultiPoint docs
* [ios, macos] Rewrote shape and feature docs
Rewrote documentation about MGLShape, its subclasses, and MGLFeature to emphasize runtime styling uses over annotation uses, associate each type with real-world concepts, cross-reference related style layer classes, and cross-reference related or easily confused shape classes. Links to the GeoJSON specification have been updated to RFC 7946.
* [ios, macos] Expanded style layer docs
With this change, documentation about style layer classes is nominally based on the documentation in the style specification. However, all the existing layer types’ documentation has been overridden to explain what the layer looks like, relate the layer to a real-world concept, and cross-reference related geometry classes. This change also corrects the description of MGLBackgroundStyleLayer, which erroneously stated that the identifier must be “background”, whereas that only happens to be true by default for Studio template styles.
* [ios, macos] Wrap style layer docs
* [ios, macos] Removed unused code
* [ios, macos] Corrected symbol references in docs
* [ios, macos] Corrected typo in abstract class exception
Diffstat (limited to 'platform/darwin/src/MGLStyle.h')
| -rw-r--r-- | platform/darwin/src/MGLStyle.h | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/platform/darwin/src/MGLStyle.h b/platform/darwin/src/MGLStyle.h index 96dd502c30..1e0b87a73f 100644 --- a/platform/darwin/src/MGLStyle.h +++ b/platform/darwin/src/MGLStyle.h @@ -40,7 +40,7 @@ static const NSInteger MGLStyleDefaultVersion = 9; via `-[MGLMapView style]` by updating the style's data sources or layers. @note Wait until the map style has finished loading before modifying a map's - style via any of the MGLStyle instance methods below. + style via any of the `MGLStyle` instance methods below. You can use the `MGLMapViewDelegate` methods `-mapViewDidFinishLoadingMap:` or `-mapView:didFinishLoadingStyle:` as indicators that it's safe to modify the map's style. |