From 44fbba8514554dd05a0d8abc3f33f21840a73033 Mon Sep 17 00:00:00 2001 From: Jason Wray Date: Tue, 29 Jan 2019 16:06:10 -0800 Subject: [darwin, docs] Improve method/property linking in jazzy --- platform/darwin/src/MGLShape.h | 2 +- platform/darwin/src/MGLStyle.h | 46 +++++++++++++++++------------------ platform/ios/src/MGLMapView.h | 4 +-- platform/ios/src/MGLMapViewDelegate.h | 2 +- 4 files changed, 27 insertions(+), 27 deletions(-) diff --git a/platform/darwin/src/MGLShape.h b/platform/darwin/src/MGLShape.h index e0ef0999db..6954045fd7 100644 --- a/platform/darwin/src/MGLShape.h +++ b/platform/darwin/src/MGLShape.h @@ -7,7 +7,7 @@ NS_ASSUME_NONNULL_BEGIN /** `MGLShape` is an abstract class that represents a shape or annotation. Shapes - constitute the content of a map – not only the overlays atop the map, but also + constitute the content of a map — not only the overlays atop the map, but also the content that forms the base map. Create instances of `MGLPointAnnotation`, `MGLPointCollection`, `MGLPolyline`, diff --git a/platform/darwin/src/MGLStyle.h b/platform/darwin/src/MGLStyle.h index 1ab0f5e82e..f3a4db0773 100644 --- a/platform/darwin/src/MGLStyle.h +++ b/platform/darwin/src/MGLStyle.h @@ -12,8 +12,8 @@ NS_ASSUME_NONNULL_BEGIN /** A version number identifying the default version of the Mapbox Streets style - obtained through the `-streetsStyleURL` method. This version number may also be - passed into the `-streetsStyleURLWithVersion:` method. + obtained through the `MGLStyle.streetsStyleURL` method. This version number may also be + passed into the `+[MGLStyle streetsStyleURLWithVersion:]` method. The value of this constant generally corresponds to the latest released version as of the date on which this SDK was published. You can use this constant to @@ -24,7 +24,7 @@ NS_ASSUME_NONNULL_BEGIN @warning The value of this constant may change in a future release of the SDK. If you use any feature that depends on a specific aspect of a default style - – for instance, the minimum zoom level that includes roads – you may use the + — for instance, the minimum zoom level that includes roads — you may use the current value of this constant or the underlying style URL, but do not use the constant itself. Such details may change significantly from version to version. @@ -41,11 +41,11 @@ FOUNDATION_EXTERN MGL_EXPORT MGLExceptionName const MGLRedundantSourceIdentifier The proxy object for the current map style. MGLStyle provides a set of convenience methods for changing Mapbox - default styles using `-[MGLMapView styleURL]`. + default styles using `MGLMapView.styleURL`. Learn more about Mapbox default styles. It is also possible to directly manipulate the current map style - via `-[MGLMapView style]` by updating the style's data sources or layers. + via `MGLMapView.style` by updating the style's data sources or layers. @note Wait until the map style has finished loading before modifying a map's style via any of the `MGLStyle` instance methods below. You can use the @@ -74,9 +74,9 @@ MGL_EXPORT is specified explicitly. @warning The return value may change in a future release of the SDK. If you use - any feature that depends on a specific aspect of a default style – for - instance, the minimum zoom level that includes roads – use the - `-streetsStyleURLWithVersion:` method instead. Such details may change + any feature that depends on a specific aspect of a default style — for + instance, the minimum zoom level that includes roads — use the + `+streetsStyleURLWithVersion:` method instead. Such details may change significantly from version to version. */ @property (class, nonatomic, readonly) NSURL *streetsStyleURL; @@ -104,9 +104,9 @@ MGL_EXPORT Outdoors is a general-purpose style tailored to outdoor activities. @warning The return value may change in a future release of the SDK. If you use - any feature that depends on a specific aspect of a default style – for - instance, the minimum zoom level that includes roads – use the - `-outdoorsStyleURLWithVersion:` method instead. Such details may change + any feature that depends on a specific aspect of a default style — for + instance, the minimum zoom level that includes roads — use the + `+outdoorsStyleURLWithVersion:` method instead. Such details may change significantly from version to version. */ @property (class, nonatomic, readonly) NSURL *outdoorsStyleURL; @@ -128,9 +128,9 @@ MGL_EXPORT Light is a subtle, light-colored backdrop for data visualizations. @warning The return value may change in a future release of the SDK. If you use - any feature that depends on a specific aspect of a default style – for - instance, the minimum zoom level that includes roads – use the - `-lightStyleURLWithVersion:` method instead. Such details may change + any feature that depends on a specific aspect of a default style — for + instance, the minimum zoom level that includes roads — use the + `+lightStyleURLWithVersion:` method instead. Such details may change significantly from version to version. */ @property (class, nonatomic, readonly) NSURL *lightStyleURL; @@ -153,9 +153,9 @@ MGL_EXPORT Dark is a subtle, dark-colored backdrop for data visualizations. @warning The return value may change in a future release of the SDK. If you use - any feature that depends on a specific aspect of a default style – for - instance, the minimum zoom level that includes roads – use the - `-darkStyleURLWithVersion:` method instead. Such details may change + any feature that depends on a specific aspect of a default style — for + instance, the minimum zoom level that includes roads — use the + `+darkStyleURLWithVersion:` method instead. Such details may change significantly from version to version. */ @property (class, nonatomic, readonly) NSURL *darkStyleURL; @@ -178,9 +178,9 @@ MGL_EXPORT Satellite is high-resolution satellite and aerial imagery. @warning The return value may change in a future release of the SDK. If you use - any feature that depends on a specific aspect of a default style – for - instance, the raster tile sets included in the style – use the - `-satelliteStyleURLWithVersion:` method instead. Such details may change + any feature that depends on a specific aspect of a default style — for + instance, the raster tile sets included in the style — use the + `+satelliteStyleURLWithVersion:` method instead. Such details may change significantly from version to version. #### Related example @@ -214,9 +214,9 @@ MGL_EXPORT Streets. @warning The return value may change in a future release of the SDK. If you use - any feature that depends on a specific aspect of a default style – for - instance, the minimum zoom level that includes roads – use the - `-satelliteStreetsStyleURLWithVersion:` method instead. Such details may + any feature that depends on a specific aspect of a default style — for + instance, the minimum zoom level that includes roads — use the + `+satelliteStreetsStyleURLWithVersion:` method instead. Such details may change significantly from version to version. #### Related example diff --git a/platform/ios/src/MGLMapView.h b/platform/ios/src/MGLMapView.h index cad35c81d8..79460b714a 100644 --- a/platform/ios/src/MGLMapView.h +++ b/platform/ios/src/MGLMapView.h @@ -450,7 +450,7 @@ MGL_EXPORT IB_DESIGNABLE transition. If you don’t want to animate the change, use the `-setUserLocationVerticalAlignment:animated:` method instead. */ -@property (nonatomic, assign) MGLAnnotationVerticalAlignment userLocationVerticalAlignment __attribute__((deprecated("Use -[MGLMapViewDelegate mapViewUserLocationAnchorPoint:] instead."))); +@property (nonatomic, assign) MGLAnnotationVerticalAlignment userLocationVerticalAlignment __attribute__((deprecated("Use `-[MGLMapViewDelegate mapViewUserLocationAnchorPoint:]` instead."))); /** Sets the vertical alignment of the user location annotation within the @@ -461,7 +461,7 @@ MGL_EXPORT IB_DESIGNABLE position within the map view. If `NO`, the user location annotation instantaneously moves to its new position. */ -- (void)setUserLocationVerticalAlignment:(MGLAnnotationVerticalAlignment)alignment animated:(BOOL)animated __attribute__((deprecated("Use -[MGLMapViewDelegate mapViewUserLocationAnchorPoint:] instead."))); +- (void)setUserLocationVerticalAlignment:(MGLAnnotationVerticalAlignment)alignment animated:(BOOL)animated __attribute__((deprecated("Use `-[MGLMapViewDelegate mapViewUserLocationAnchorPoint:]` instead."))); /** Updates the position of the user location annotation view by retreiving the user's last diff --git a/platform/ios/src/MGLMapViewDelegate.h b/platform/ios/src/MGLMapViewDelegate.h index e9f864f370..30550ca6a1 100644 --- a/platform/ios/src/MGLMapViewDelegate.h +++ b/platform/ios/src/MGLMapViewDelegate.h @@ -346,7 +346,7 @@ NS_ASSUME_NONNULL_BEGIN the map view with respect to the content insets. This method will override any values set by `MGLMapView.userLocationVerticalAlignment` - or `-[MGLMapView setUserLocationVerticalAlignment:]`. + or `-[MGLMapView setUserLocationVerticalAlignment:animated:]`. @param mapView The map view that is tracking the user's location. */ -- cgit v1.2.1