Skip to content
This repository was archived by the owner on Aug 8, 2023. It is now read-only.

Commit c6288a7

Browse files
committed
[ios, macos] Clarify API docs for point collection
1 parent 7898c2a commit c6288a7

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

platform/darwin/src/MGLPointCollection.h

+7-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,13 @@
55
#import "MGLShape.h"
66

77
/**
8-
The `MGLPointCollection` class is used to define shapes composed of multiple
9-
points.
8+
The `MGLPointCollection` class is used to define an array of coordinates.
9+
10+
@note `MGLPointCollection` objects cannot be added to a map view using
11+
`-[MGLMapView addAnnotations:]` and related methods. However, when used in a
12+
`MGLPointCollectionFeature` to initialize a `MGLGeoJSONSource` that is added
13+
to the map view's style, the point collection represents as a group of distinct
14+
annotations.
1015
*/
1116
@interface MGLPointCollection : MGLShape <MGLOverlay>
1217

platform/ios/src/MGLMapView.h

+4-5
Original file line numberDiff line numberDiff line change
@@ -895,11 +895,10 @@ IB_DESIGNABLE
895895
/**
896896
Adds an annotation to the map view.
897897
898-
@note `MGLMultiPolyline`, `MGLMultiPolygon`, and `MGLShapeCollection` objects
899-
cannot be added to the map view at this time. Nor can `MGLMultiPoint`
900-
objects that are not instances of `MGLPolyline` or `MGLPolygon`. Any
901-
multipoint, multipolyline, multipolygon, or shape collection object that is
902-
specified is silently ignored.
898+
@note `MGLMultiPolyline`, `MGLMultiPolygon`, `MGLShapeCollection`, and
899+
`MGLPointCollection` objects cannot be added to the map view at this time.
900+
Any multipoint, multipolyline, multipolygon, shape collection or point
901+
collection, object that is specified is silently ignored.
903902
904903
@param annotation The annotation object to add to the receiver. This object
905904
must conform to the `MGLAnnotation` protocol. The map view retains the

0 commit comments

Comments
 (0)