diff --git a/platform/darwin/src/MGLAccountManager.h b/platform/darwin/src/MGLAccountManager.h index 63440046f..2a11b2869 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 746cb686c..2579451f2 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 aec0d5fe9..ce09b8b39 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 622c31c7b..546984103 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 de851bc1e..a70b603f0 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 9e160d050..af50bb22d 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