summaryrefslogtreecommitdiff
path: root/platform/ios/src/MGLMapView.h
diff options
context:
space:
mode:
authorJason Wray <friedbunny@users.noreply.github.com>2016-07-12 14:19:44 -0400
committerGitHub <noreply@github.com>2016-07-12 14:19:44 -0400
commit2f3d77538b4fc9dee2417cd54ea1f9af3899cfdf (patch)
tree3708c4ac806664218acce7e24aad7b2615bc5693 /platform/ios/src/MGLMapView.h
parentab6a17eec7d65afa874547347a1beb1a4c026c10 (diff)
downloadqtlocation-mapboxgl-2f3d77538b4fc9dee2417cd54ea1f9af3899cfdf.tar.gz
[ios, macos] Reorganize jazzy’s navigation categories; cleanup docs (#5660)
An attempt to better surface relevant information. Includes slight cleanups of inline documentation. - Demotes MGLMapDebugMaskOptions to "Other Enums”. - Demotes MGLMapViewDecelerationRate* and MGLStyleDefaultVersion to "Other Constants”. - Demotes MGLOfflinePack's less significant global types. - Demotes MGLAnnotationVerticalAlignment and documents its usage caveat. - Demotes MGLAnnotationViewDragState and removes extra asterisk. - Adds note to `MGLUserTrackingMode` about usage with `MGLMapView.userTrackingMode`. - MGLAccountManager is currently only used for access tokens. - Adds missing closing bracket.
Diffstat (limited to 'platform/ios/src/MGLMapView.h')
-rw-r--r--platform/ios/src/MGLMapView.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/platform/ios/src/MGLMapView.h b/platform/ios/src/MGLMapView.h
index de851bc1e5..a70b603f02 100644
--- a/platform/ios/src/MGLMapView.h
+++ b/platform/ios/src/MGLMapView.h
@@ -30,7 +30,10 @@ extern const CGFloat MGLMapViewDecelerationRateFast;
/** Disables decleration in a map view. */
extern const CGFloat MGLMapViewDecelerationRateImmediate;
-/** The vertical alignment of an annotation within a map view. */
+/**
+ The vertical alignment of an annotation within a map view. Used with
+ `MGLMapView.userLocationVerticalAlignment`.
+ */
typedef NS_ENUM(NSUInteger, MGLAnnotationVerticalAlignment) {
/** Aligns the annotation vertically in the center of the map view. */
MGLAnnotationVerticalAlignmentCenter = 0,