summaryrefslogtreecommitdiff
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
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.
-rw-r--r--platform/darwin/src/MGLAccountManager.h2
-rw-r--r--platform/darwin/src/MGLTypes.h5
-rw-r--r--platform/ios/jazzy.yml16
-rw-r--r--platform/ios/src/MGLAnnotationView.h4
-rw-r--r--platform/ios/src/MGLMapView.h5
-rw-r--r--platform/macos/jazzy.yml12
6 files changed, 12 insertions, 32 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,
diff --git a/platform/ios/jazzy.yml b/platform/ios/jazzy.yml
index aec0d5fe9f..ce09b8b39d 100644
--- a/platform/ios/jazzy.yml
+++ b/platform/ios/jazzy.yml
@@ -19,22 +19,15 @@ custom_categories:
children:
- MGLAccountManager
- MGLMapCamera
- - MGLMapDebugMaskOptions
- MGLMapView
- - MGLMapViewDecelerationRateFast
- - MGLMapViewDecelerationRateImmediate
- - MGLMapViewDecelerationRateNormal
- MGLMapViewDelegate
- MGLStyle
- - MGLStyleDefaultVersion
- MGLUserTrackingMode
- name: Annotations
children:
- MGLAnnotation
- MGLAnnotationImage
- - MGLAnnotationVerticalAlignment
- MGLAnnotationView
- - MGLAnnotationViewDragState
- MGLCalloutView
- MGLCalloutViewDelegate
- MGLMultiPoint
@@ -62,17 +55,8 @@ custom_categories:
- MGLOfflineRegion
- MGLOfflineStorage
- MGLOfflinePack
- - MGLOfflinePackAdditionCompletionHandler
- - MGLOfflinePackErrorNotification
- - MGLOfflinePackErrorUserInfoKey
- - MGLOfflinePackMaximumCountUserInfoKey
- - MGLOfflinePackMaximumMapboxTilesReachedNotification
- MGLOfflinePackProgress
- - MGLOfflinePackProgressChangedNotification
- - MGLOfflinePackProgressUserInfoKey
- - MGLOfflinePackRemovalCompletionHandler
- MGLOfflinePackState
- - MGLOfflinePackStateUserInfoKey
- MGLTilePyramidOfflineRegion
- name: Geometry
children:
diff --git a/platform/ios/src/MGLAnnotationView.h b/platform/ios/src/MGLAnnotationView.h
index 622c31c7b3..5469841036 100644
--- a/platform/ios/src/MGLAnnotationView.h
+++ b/platform/ios/src/MGLAnnotationView.h
@@ -6,7 +6,7 @@ NS_ASSUME_NONNULL_BEGIN
@protocol MGLAnnotation;
-/** These constants indicate the current drag state of an annotation view. **/
+/** These constants indicate the current drag state of an annotation view. */
typedef NS_ENUM(NSUInteger, MGLAnnotationViewDragState) {
/**
The view is not involved in a drag operation.
@@ -64,7 +64,7 @@ typedef NS_ENUM(NSUInteger, MGLAnnotationViewDragState) {
leaves the viewport, the map view moves its associated view to a reuse queue.
When a new annotation becomes visible, you can request a view for that
annotation by passing the appropriate reuse identifier string to the
- `-[MGLMapView dequeueReusableAnnotationViewWithIdentifier:` method.
+ `-[MGLMapView dequeueReusableAnnotationViewWithIdentifier:]` method.
@param reuseIdentifier A unique string identifier for this view that allows you
to reuse this view with multiple similar annotations. You can set this
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,
diff --git a/platform/macos/jazzy.yml b/platform/macos/jazzy.yml
index 9e160d050f..af50bb22df 100644
--- a/platform/macos/jazzy.yml
+++ b/platform/macos/jazzy.yml
@@ -18,11 +18,9 @@ custom_categories:
children:
- MGLAccountManager
- MGLMapCamera
- - MGLMapDebugMaskOptions
- MGLMapView
- MGLMapViewDelegate
- MGLStyle
- - MGLStyleDefaultVersion
- MGLUserTrackingMode
- name: Annotations
children:
@@ -52,17 +50,8 @@ custom_categories:
- MGLOfflineRegion
- MGLOfflineStorage
- MGLOfflinePack
- - MGLOfflinePackAdditionCompletionHandler
- - MGLOfflinePackErrorNotification
- - MGLOfflinePackErrorUserInfoKey
- - MGLOfflinePackMaximumCountUserInfoKey
- - MGLOfflinePackMaximumMapboxTilesReachedNotification
- MGLOfflinePackProgress
- - MGLOfflinePackProgressChangedNotification
- - MGLOfflinePackProgressUserInfoKey
- - MGLOfflinePackRemovalCompletionHandler
- MGLOfflinePackState
- - MGLOfflinePackStateUserInfoKey
- MGLTilePyramidOfflineRegion
- name: Geometry
children:
@@ -75,6 +64,7 @@ custom_categories:
- MGLCoordinateBoundsMake
- MGLCoordinateBoundsOffset
- MGLCoordinateFormatter
+ - MGLCoordinateInCoordinateBounds
- MGLCoordinateSpan
- MGLCoordinateSpanEqualToCoordinateSpan
- MGLCoordinateSpanMake