summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJosh Erb <josh.erb@mapbox.com>2018-10-23 17:37:28 -0400
committerJosh Erb <josherb4@gmail.com>2018-10-24 13:24:23 -0400
commit2d471da9ce77f2ac9a0e03c59cb19c75325240b8 (patch)
treea0fd331afa4c1f36156746c185af61ed80d87530
parent0d4c3656a3d14a28d6359b27c01e338fbdfc1c87 (diff)
downloadqtlocation-mapboxgl-2d471da9ce77f2ac9a0e03c59cb19c75325240b8.tar.gz
[ios][documentation] add two links for delegates
* MGLMapView <-> MGLMapViewDelegate * MGLCalloutView <-> MGLCalloutViewDelegate * MGLLocationManager <-> MGLLocationManagerDelegate
-rw-r--r--platform/darwin/src/MGLLocationManager.h2
-rw-r--r--platform/ios/src/MGLCalloutView.h3
-rw-r--r--platform/ios/src/MGLMapView.h5
3 files changed, 10 insertions, 0 deletions
diff --git a/platform/darwin/src/MGLLocationManager.h b/platform/darwin/src/MGLLocationManager.h
index 121dcc2293..d6cfab60d8 100644
--- a/platform/darwin/src/MGLLocationManager.h
+++ b/platform/darwin/src/MGLLocationManager.h
@@ -13,6 +13,8 @@ NS_ASSUME_NONNULL_BEGIN
Core Location framework’s `CLLocationManager` class, but your implementation
does not need to be based on `CLLocationManager`.
+ To receive location updates from an object that conforms to the `MGLLocationManager`
+ protocol, use the optional methods available in the `MGLLocationManagerDelegate` protocol.
*/
@protocol MGLLocationManager <NSObject>
diff --git a/platform/ios/src/MGLCalloutView.h b/platform/ios/src/MGLCalloutView.h
index 689b159fd7..4f88429fbb 100644
--- a/platform/ios/src/MGLCalloutView.h
+++ b/platform/ios/src/MGLCalloutView.h
@@ -8,6 +8,9 @@ NS_ASSUME_NONNULL_BEGIN
/**
A protocol for a `UIView` subclass that displays information about a selected
annotation near that annotation.
+
+ To receive updates from an object that conforms to the `MGLCalloutView` protocol,
+ use the optional methods available in the `MGLCalloutViewDelegate` protocol.
*/
@protocol MGLCalloutView <NSObject>
diff --git a/platform/ios/src/MGLMapView.h b/platform/ios/src/MGLMapView.h
index 5312804cd2..27394b61ff 100644
--- a/platform/ios/src/MGLMapView.h
+++ b/platform/ios/src/MGLMapView.h
@@ -129,6 +129,11 @@ FOUNDATION_EXTERN MGL_EXPORT MGLExceptionName const MGLResourceNotFoundException
Access tokens associate requests to Mapbox’s vector tile and style APIs with
your Mapbox account. They also deter other developers from using your styles
without your permission.
+
+ Because `MGLMapView` loads asynchronously, several delegate methods are available
+ for receiving map-related updates. These methods can be used to ensure that certain operations
+ have completed before taking any additional actions. Information on these methods is located
+ in the `MGLMapViewDelegate` protocol documentation.
Adding your own gesture recognizer to `MGLMapView` will block the corresponding
gesture recognizer built into `MGLMapView`. To avoid conflicts, define which