From 3fed3c10edb2cd015bd733a22c56ace7af900ef8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Minh=20Nguye=CC=82=CC=83n?= Date: Thu, 8 Dec 2016 03:40:59 -0800 Subject: [ios, macos] Expanded source documentation Also fixed a few stray references to GeoJSON sources. --- platform/darwin/src/MGLShapeSource.h | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) (limited to 'platform/darwin/src/MGLShapeSource.h') diff --git a/platform/darwin/src/MGLShapeSource.h b/platform/darwin/src/MGLShapeSource.h index 5067466e6d..407d9c45a1 100644 --- a/platform/darwin/src/MGLShapeSource.h +++ b/platform/darwin/src/MGLShapeSource.h @@ -57,10 +57,15 @@ extern const MGLShapeSourceOption MGLShapeSourceOptionBuffer; extern const MGLShapeSourceOption MGLShapeSourceOptionSimplificationTolerance; /** - A shape source. - - @see The - style specification. + `MGLShapeSource` is a map content source that supplies vector shapes to be + shown on the map. The shapes may be instances of `MGLShape` or `MGLFeature`, + or they may be defined by local or external + GeoJSON code. A shape source is added to an + `MGLStyle` object along with an `MGLVectorStyleLayer` object. The vector style + layer defines the appearance of any content supplied by the shape source. + + Any vector style layer initialized with a shape source should have a `nil` + value in its `sourceLayerIdentifier` property. */ @interface MGLShapeSource : MGLSource @@ -109,12 +114,12 @@ extern const MGLShapeSourceOption MGLShapeSourceOptionSimplificationTolerance; #pragma mark Accessing a Source’s Content /** - The contents of the source. A shape can represent a GeoJSON geometry, a feature, - or a collection of features. + The contents of the source. A shape can represent a GeoJSON geometry, a + feature, or a collection of features. - If the receiver was initialized using `-initWithIdentifier:URL:options:`, this property - is set to `nil`. This property is unavailable until the receiver is passed into - `-[MGLStyle addSource]`. + If the receiver was initialized using `-initWithIdentifier:URL:options:`, this + property is set to `nil`. This property is unavailable until the receiver is + passed into `-[MGLStyle addSource]`. */ @property (nonatomic, nullable) MGLShape *shape; @@ -135,8 +140,8 @@ extern const MGLShapeSourceOption MGLShapeSourceOptionSimplificationTolerance; /** The URL to the GeoJSON document that specifies the contents of the source. - If the receiver was initialized using `-initWithIdentifier:geoJSONData:options`, - this property is set to `nil`. + If the receiver was initialized using + `-initWithIdentifier:geoJSONData:options`, this property is set to `nil`. */ @property (nonatomic, nullable) NSURL *URL; -- cgit v1.2.1