summaryrefslogtreecommitdiff
path: root/platform/ios
diff options
context:
space:
mode:
authorJason Wray <jason@mapbox.com>2017-10-11 10:06:30 -0700
committerJason Wray <jason@mapbox.com>2017-10-11 10:06:30 -0700
commitb7879d5a370f232b3030fb404a9eb8a51d3a7eb1 (patch)
tree337da4fdd1fa6ab7154cd933daef0a79fc443e62 /platform/ios
parent6d673799f8e632e5566197433f67c39fd3663565 (diff)
downloadqtlocation-mapboxgl-b7879d5a370f232b3030fb404a9eb8a51d3a7eb1.tar.gz
[ios] Update MGLUserLocation.heading for showsUserHeadingIndicatorupstream/fb-heading-doc
Diffstat (limited to 'platform/ios')
-rw-r--r--platform/ios/src/MGLUserLocation.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/platform/ios/src/MGLUserLocation.h b/platform/ios/src/MGLUserLocation.h
index 91abadbcb7..4e01cf00c9 100644
--- a/platform/ios/src/MGLUserLocation.h
+++ b/platform/ios/src/MGLUserLocation.h
@@ -34,7 +34,8 @@ MGL_EXPORT
The heading of the user location. (read-only)
This property is `nil` if the user location tracking mode is not
- `MGLUserTrackingModeFollowWithHeading`.
+ `MGLUserTrackingModeFollowWithHeading` or if
+ `MGLMapView.showsUserHeadingIndicator` is disabled.
*/
@property (nonatomic, readonly, nullable) CLHeading *heading;