summaryrefslogtreecommitdiff
path: root/platform/darwin
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/darwin
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/darwin')
-rw-r--r--platform/darwin/src/MGLAccountManager.h2
-rw-r--r--platform/darwin/src/MGLTypes.h5
2 files changed, 5 insertions, 2 deletions
diff --git a/platform/darwin/src/MGLAccountManager.h b/platform/darwin/src/MGLAccountManager.h
index 63440046f7..2a11b2869e 100644
--- a/platform/darwin/src/MGLAccountManager.h
+++ b/platform/darwin/src/MGLAccountManager.h
@@ -6,7 +6,7 @@ NS_ASSUME_NONNULL_BEGIN
/**
The MGLAccountManager object provides a global way to set a Mapbox API access
- token, as well as other settings used framework-wide.
+ token.
*/
@interface MGLAccountManager : NSObject
diff --git a/platform/darwin/src/MGLTypes.h b/platform/darwin/src/MGLTypes.h
index 746cb686c0..2579451f2d 100644
--- a/platform/darwin/src/MGLTypes.h
+++ b/platform/darwin/src/MGLTypes.h
@@ -29,7 +29,10 @@ typedef NS_ENUM(NSInteger, MGLErrorCode) {
MGLErrorCodeConnectionFailed = 3,
};
-/** The mode used to track the user location on the map. */
+/**
+ The mode used to track the user location on the map. Used with
+ `MGLMapView.userTrackingMode`.
+ */
typedef NS_ENUM(NSUInteger, MGLUserTrackingMode) {
/** The map does not follow the user location. */
MGLUserTrackingModeNone = 0,