From a2a4222f7bac4300867f28221ac0a5b67a708702 Mon Sep 17 00:00:00 2001 From: jmkiley Date: Tue, 13 Jun 2017 16:55:59 -0700 Subject: [PATCH] [ios, macos]revisions round 1 --- platform/darwin/src/MGLForegroundStyleLayer.h | 2 ++ platform/darwin/src/MGLMultiPoint.h | 5 +++-- platform/darwin/src/MGLShape.h | 4 ++-- platform/darwin/src/MGLStyleValue.h | 3 ++- platform/darwin/src/MGLVectorStyleLayer.h | 3 ++- 5 files changed, 11 insertions(+), 6 deletions(-) diff --git a/platform/darwin/src/MGLForegroundStyleLayer.h b/platform/darwin/src/MGLForegroundStyleLayer.h index 79270d1cc87..deeb7051f92 100644 --- a/platform/darwin/src/MGLForegroundStyleLayer.h +++ b/platform/darwin/src/MGLForegroundStyleLayer.h @@ -13,6 +13,8 @@ NS_ASSUME_NONNULL_BEGIN Create instances of `MGLRasterStyleLayer` and the concrete subclasses of `MGLVectorStyleLayer` in order to use `MGLForegroundStyleLayer`'s methods. + Do not create instances of this class directly, and do not create your own + subclasses of this class. */ MGL_EXPORT @interface MGLForegroundStyleLayer : MGLStyleLayer diff --git a/platform/darwin/src/MGLMultiPoint.h b/platform/darwin/src/MGLMultiPoint.h index e669aff0b02..9b089ef8c1c 100644 --- a/platform/darwin/src/MGLMultiPoint.h +++ b/platform/darwin/src/MGLMultiPoint.h @@ -11,8 +11,9 @@ NS_ASSUME_NONNULL_BEGIN composed of multiple vertices. Create instances of `MGLPolyline` or `MGLPolygon` in order to use - properties of `MGLMultiPoint`. You can use the method and properties of this - class to access information about the vertices of the line or polygon. + properties of `MGLMultiPoint`. Do not create instances of `MGLMultiPoint` + directly. You can use the method and properties of this class to access + information about the vertices of the line or polygon. Do not confuse `MGLMultiPoint` with `MGLPointCollection`, which represents a collection of related but disconnected points. diff --git a/platform/darwin/src/MGLShape.h b/platform/darwin/src/MGLShape.h index 416d68bf799..f0de4abaa62 100644 --- a/platform/darwin/src/MGLShape.h +++ b/platform/darwin/src/MGLShape.h @@ -12,8 +12,8 @@ NS_ASSUME_NONNULL_BEGIN Create instances of `MGLPointAnnotation`, `MGLPointCollection`, `MGLPolyline`, `MGLMultiPolyline`, `MGLPolygon`, `MGLMultiPolygon`, or `MGLShapeCollection` in - order to use `MGLShape`'s methods. The shape classes correspond to the - Geometry object + order to use `MGLShape`'s methods. Do not create instances of `MGLShape` directly. + The shape classes correspond to the Geometry object types in the GeoJSON standard, but some have nonstandard names for backwards compatibility. diff --git a/platform/darwin/src/MGLStyleValue.h b/platform/darwin/src/MGLStyleValue.h index 46943c66241..57bd562cb61 100644 --- a/platform/darwin/src/MGLStyleValue.h +++ b/platform/darwin/src/MGLStyleValue.h @@ -240,7 +240,8 @@ MGL_EXPORT `MGLCompositeStyleFunction` object. Create instances of `MGLCameraStyleFunction`, `MGLSourceStyleFunction`, and - `MGLCompositeStyleFunction` in order to use `MGLStyleFunction`'s methods. + `MGLCompositeStyleFunction` in order to use `MGLStyleFunction`'s methods. Do + not create instances of `MGLStyleFunction` directly. The `MGLStyleFunction` class takes a generic parameter `T` that indicates the Foundation class being wrapped by this class. diff --git a/platform/darwin/src/MGLVectorStyleLayer.h b/platform/darwin/src/MGLVectorStyleLayer.h index 9535777b244..fbf39e4b475 100644 --- a/platform/darwin/src/MGLVectorStyleLayer.h +++ b/platform/darwin/src/MGLVectorStyleLayer.h @@ -10,7 +10,8 @@ NS_ASSUME_NONNULL_BEGIN is defined by an `MGLShapeSource` or `MGLVectorSource` object. Create instances of `MGLCircleStyleLayer`, `MGLFillStyleLayer`, `MGLLineStyleLayer`, - and `MGLSymbolStyleLayer` in order to use `MGLVectorStyleLayer`'s properties and methods. + and `MGLSymbolStyleLayer` in order to use `MGLVectorStyleLayer`'s properties and + methods. Do not create instances of `MGLVectorStyleLayer` directly. */ MGL_EXPORT @interface MGLVectorStyleLayer : MGLForegroundStyleLayer