From e8f6c758965fb18845f27948906e8a766ed8ba12 Mon Sep 17 00:00:00 2001 From: Jordan Kiley Date: Tue, 14 Mar 2017 12:31:31 -0700 Subject: [ios, macos] API doc revisions (#8396) - Changed `make style-code-darwin` to `make darwin-style-code` in relevant files - Added some doc clarifications: - `MGLInterpolationModeExponential` and `MGLInterpolationModeInterval` can be used with `MGLCameraStyleFunction` (I am not sure how to accurately reflect this in the documentation for `MGLCompositeStyleFunction`) - Do not add a style layer to the style property on a map view before the style has finished loading - Create individual style layers from a `MGLShapeCollectionFeature` --- platform/darwin/src/MGLBackgroundStyleLayer.h | 2 +- platform/darwin/src/MGLCircleStyleLayer.h | 2 +- platform/darwin/src/MGLFeature.h | 6 ++++++ platform/darwin/src/MGLFillStyleLayer.h | 2 +- platform/darwin/src/MGLLineStyleLayer.h | 2 +- platform/darwin/src/MGLRasterStyleLayer.h | 2 +- platform/darwin/src/MGLStyleLayer.h | 3 +++ platform/darwin/src/MGLStyleLayer.h.ejs | 2 +- platform/darwin/src/MGLSymbolStyleLayer.h | 2 +- 9 files changed, 16 insertions(+), 7 deletions(-) (limited to 'platform') diff --git a/platform/darwin/src/MGLBackgroundStyleLayer.h b/platform/darwin/src/MGLBackgroundStyleLayer.h index 3b987dbc99..cd218d9fb4 100644 --- a/platform/darwin/src/MGLBackgroundStyleLayer.h +++ b/platform/darwin/src/MGLBackgroundStyleLayer.h @@ -1,5 +1,5 @@ // This file is generated. -// Edit platform/darwin/scripts/generate-style-code.js, then run `make style-code-darwin`. +// Edit platform/darwin/scripts/generate-style-code.js, then run `make darwin-style-code`. #import "MGLFoundation.h" #import "MGLStyleValue.h" diff --git a/platform/darwin/src/MGLCircleStyleLayer.h b/platform/darwin/src/MGLCircleStyleLayer.h index d1d48d65c6..69c823a868 100644 --- a/platform/darwin/src/MGLCircleStyleLayer.h +++ b/platform/darwin/src/MGLCircleStyleLayer.h @@ -1,5 +1,5 @@ // This file is generated. -// Edit platform/darwin/scripts/generate-style-code.js, then run `make style-code-darwin`. +// Edit platform/darwin/scripts/generate-style-code.js, then run `make darwin-style-code`. #import "MGLFoundation.h" #import "MGLStyleValue.h" diff --git a/platform/darwin/src/MGLFeature.h b/platform/darwin/src/MGLFeature.h index 2380a817e3..491c89b608 100644 --- a/platform/darwin/src/MGLFeature.h +++ b/platform/darwin/src/MGLFeature.h @@ -229,6 +229,12 @@ MGL_EXPORT /** An `MGLShapeCollectionFeature` object associates a shape collection with an optional identifier and attributes. + + `MGLShapeCollectionFeature` is most commonly used to add multiple shapes to a single + `MGLShapeSource`. Configure the appearance of an `MGLSource`’s shape collection + collectively using an `MGLSymbolStyleLayer` object, or use multiple instances of + `MGLCircleStyleLayer`, `MGLFillStyleLayer`, and `MGLLineStyleLayer` to + configure the appearance of each kind of shape inside the collection. A shape collection feature is known as a feature collection diff --git a/platform/darwin/src/MGLFillStyleLayer.h b/platform/darwin/src/MGLFillStyleLayer.h index d1d90b5a23..1f3cfc8af5 100644 --- a/platform/darwin/src/MGLFillStyleLayer.h +++ b/platform/darwin/src/MGLFillStyleLayer.h @@ -1,5 +1,5 @@ // This file is generated. -// Edit platform/darwin/scripts/generate-style-code.js, then run `make style-code-darwin`. +// Edit platform/darwin/scripts/generate-style-code.js, then run `make darwin-style-code`. #import "MGLFoundation.h" #import "MGLStyleValue.h" diff --git a/platform/darwin/src/MGLLineStyleLayer.h b/platform/darwin/src/MGLLineStyleLayer.h index e0f8d69a81..e03f3e347e 100644 --- a/platform/darwin/src/MGLLineStyleLayer.h +++ b/platform/darwin/src/MGLLineStyleLayer.h @@ -1,5 +1,5 @@ // This file is generated. -// Edit platform/darwin/scripts/generate-style-code.js, then run `make style-code-darwin`. +// Edit platform/darwin/scripts/generate-style-code.js, then run `make darwin-style-code`. #import "MGLFoundation.h" #import "MGLStyleValue.h" diff --git a/platform/darwin/src/MGLRasterStyleLayer.h b/platform/darwin/src/MGLRasterStyleLayer.h index d411cba5f0..377b7f45cd 100644 --- a/platform/darwin/src/MGLRasterStyleLayer.h +++ b/platform/darwin/src/MGLRasterStyleLayer.h @@ -1,5 +1,5 @@ // This file is generated. -// Edit platform/darwin/scripts/generate-style-code.js, then run `make style-code-darwin`. +// Edit platform/darwin/scripts/generate-style-code.js, then run `make darwin-style-code`. #import "MGLFoundation.h" #import "MGLStyleValue.h" diff --git a/platform/darwin/src/MGLStyleLayer.h b/platform/darwin/src/MGLStyleLayer.h index 55f1a56490..f81643edd7 100644 --- a/platform/darwin/src/MGLStyleLayer.h +++ b/platform/darwin/src/MGLStyleLayer.h @@ -18,6 +18,9 @@ NS_ASSUME_NONNULL_BEGIN subclasses of this class. Instead, create instances of `MGLBackgroundStyleLayer` and the concrete subclasses of `MGLForegroundStyleLayer`. + + Do not add `MGLStyleLayer` objects to the `style` property of a `MGLMapView` before + `-mapView:didFinishLoadingStyle:` is called. */ MGL_EXPORT @interface MGLStyleLayer : NSObject diff --git a/platform/darwin/src/MGLStyleLayer.h.ejs b/platform/darwin/src/MGLStyleLayer.h.ejs index d5540aa3df..e6c60a76db 100644 --- a/platform/darwin/src/MGLStyleLayer.h.ejs +++ b/platform/darwin/src/MGLStyleLayer.h.ejs @@ -6,7 +6,7 @@ const enumProperties = locals.enumProperties; -%> // This file is generated. -// Edit platform/darwin/scripts/generate-style-code.js, then run `make style-code-darwin`. +// Edit platform/darwin/scripts/generate-style-code.js, then run `make darwin-style-code`. #import "MGLFoundation.h" #import "MGLStyleValue.h" diff --git a/platform/darwin/src/MGLSymbolStyleLayer.h b/platform/darwin/src/MGLSymbolStyleLayer.h index f3ea5e9179..c76efe2de7 100644 --- a/platform/darwin/src/MGLSymbolStyleLayer.h +++ b/platform/darwin/src/MGLSymbolStyleLayer.h @@ -1,5 +1,5 @@ // This file is generated. -// Edit platform/darwin/scripts/generate-style-code.js, then run `make style-code-darwin`. +// Edit platform/darwin/scripts/generate-style-code.js, then run `make darwin-style-code`. #import "MGLFoundation.h" #import "MGLStyleValue.h" -- cgit v1.2.1