From 319837a5fc588a766fc3ac58abd13f466add49c7 Mon Sep 17 00:00:00 2001 From: Jason Wray Date: Thu, 24 Jan 2019 16:45:51 -0800 Subject: [ios] Update more URLs to docs.mapbox.com/ios --- platform/darwin/src/MGLAnnotation.h | 4 +-- platform/darwin/src/MGLFeature.h | 8 ++--- platform/darwin/src/MGLGeometry.h | 2 +- platform/darwin/src/MGLImageSource.h | 2 +- platform/darwin/src/MGLMapCamera.h | 10 +++--- platform/darwin/src/MGLMapSnapshotter.h | 2 +- platform/darwin/src/MGLOfflineStorage.h | 4 +-- platform/darwin/src/MGLPointAnnotation.h | 6 ++-- platform/darwin/src/MGLPolygon.h | 2 +- platform/darwin/src/MGLPolyline.h | 2 +- platform/darwin/src/MGLRasterTileSource.h | 2 +- platform/darwin/src/MGLShapeSource.h | 8 ++--- platform/darwin/src/MGLStyle.h | 14 ++++---- platform/darwin/src/MGLStyleLayer.h | 2 +- platform/darwin/src/MGLTilePyramidOfflineRegion.h | 2 +- platform/darwin/src/MGLVectorTileSource.h | 2 +- platform/darwin/src/NSExpression+MGLAdditions.h | 8 ++--- platform/ios/DEVELOPING.md | 2 +- .../MGLStyleLayerIntegrationTests.m | 6 ++-- .../ios/Mapbox-iOS-SDK-nightly-dynamic.podspec | 6 ++-- platform/ios/Mapbox-iOS-SDK-stripped.podspec | 6 ++-- platform/ios/Mapbox-iOS-SDK.podspec | 6 ++-- platform/ios/README.md | 4 +-- platform/ios/jazzy.yml | 2 +- platform/ios/scripts/document.sh | 2 +- platform/ios/src/MGLAnnotationImage.h | 2 +- platform/ios/src/MGLAnnotationView.h | 4 +-- platform/ios/src/MGLCalloutView.h | 2 +- platform/ios/src/MGLMapView.h | 39 +++++++++++---------- platform/ios/src/MGLMapViewDelegate.h | 40 +++++++++++----------- platform/ios/src/MGLMapboxEvents.m | 2 +- platform/ios/src/MGLUserLocation.h | 4 ++- platform/ios/src/MGLUserLocationAnnotationView.h | 2 +- platform/macos/docs/pod-README.md | 4 +-- 34 files changed, 109 insertions(+), 104 deletions(-) diff --git a/platform/darwin/src/MGLAnnotation.h b/platform/darwin/src/MGLAnnotation.h index 70b0bb178d..a8ac1e7e50 100644 --- a/platform/darwin/src/MGLAnnotation.h +++ b/platform/darwin/src/MGLAnnotation.h @@ -18,8 +18,8 @@ NS_ASSUME_NONNULL_BEGIN The other methods of this protocol are optional. #### Related examples - See the - Annotation models and + See the + Annotation models and Annotation views examples to learn how to add objects that follow the `MGLAnnotation` protocol. */ diff --git a/platform/darwin/src/MGLFeature.h b/platform/darwin/src/MGLFeature.h index 51901d73c0..6a8828bf37 100644 --- a/platform/darwin/src/MGLFeature.h +++ b/platform/darwin/src/MGLFeature.h @@ -185,7 +185,7 @@ MGL_EXPORT identifier and attributes. #### Related examples - See the + See the Dynamically style interactive points example to learn how to initialize `MGLPointFeature` objects and add them to your map. */ @@ -200,7 +200,7 @@ MGL_EXPORT @see `MGLCluster` #### Related examples - See the + See the Clustering point data example to learn how to initialize clusters and add them to your map. */ @@ -217,7 +217,7 @@ MGL_EXPORT feature in GeoJSON. #### Related examples - See the + See the Add a line annotation from GeoJSON example to learn how to initialize an `MGLPolylineFeature` and add it to an `MGLMapView` object. */ @@ -284,7 +284,7 @@ MGL_EXPORT in GeoJSON. #### Related examples - See the + See the Add multiple shapes from a single shape source example to learn how to add shape data to your map using an `MGLShapeCollectionFeature` object. */ diff --git a/platform/darwin/src/MGLGeometry.h b/platform/darwin/src/MGLGeometry.h index 997ff285e2..397cf2a112 100644 --- a/platform/darwin/src/MGLGeometry.h +++ b/platform/darwin/src/MGLGeometry.h @@ -150,7 +150,7 @@ NS_INLINE BOOL MGLCoordinateBoundsIntersectsCoordinateBounds(MGLCoordinateBounds Returns `YES` if the coordinate is within the coordinate bounds. #### Related examples - See the + See the Restrict map panning to an area example to learn how to use `MGLCoordinateInCoordinateBounds` to determine if a point is within, or intersects, a given bounding box. diff --git a/platform/darwin/src/MGLImageSource.h b/platform/darwin/src/MGLImageSource.h index 5eac5e21bf..66acd39e85 100644 --- a/platform/darwin/src/MGLImageSource.h +++ b/platform/darwin/src/MGLImageSource.h @@ -43,7 +43,7 @@ MGL_EXPORT ``` #### Related examples - See the + See the Add an image example to learn how to add an image to your map using `MGLImageSource`. */ diff --git a/platform/darwin/src/MGLMapCamera.h b/platform/darwin/src/MGLMapCamera.h index 061b1e0df1..c0e40bc33b 100644 --- a/platform/darwin/src/MGLMapCamera.h +++ b/platform/darwin/src/MGLMapCamera.h @@ -11,12 +11,12 @@ NS_ASSUME_NONNULL_BEGIN some point on an `MGLMapView`. #### Related examples - See the + See the Camera animation example to learn how to create a camera that rotates - around a central point. See the Restrict map panning to an area example - to learn how to restrict map panning using `MGLMapViewDelegate`'s - `-mapView:shouldChangeFromCamera:toCamera:` method. + around a central point. See the + Restrict map panning to an area example to learn how to restrict map + panning using `MGLMapViewDelegate`'s +`-mapView:shouldChangeFromCamera:toCamera:` method. */ MGL_EXPORT @interface MGLMapCamera : NSObject diff --git a/platform/darwin/src/MGLMapSnapshotter.h b/platform/darwin/src/MGLMapSnapshotter.h index 2bd9d99fe0..146cbd2e15 100644 --- a/platform/darwin/src/MGLMapSnapshotter.h +++ b/platform/darwin/src/MGLMapSnapshotter.h @@ -165,7 +165,7 @@ typedef void (^MGLMapSnapshotCompletionHandler)(MGLMapSnapshot* _Nullable snapsh ``` #### Related examples - See the + See the Create a static map snapshot example to learn how to use the `MGLMapSnapshotter` to generate a static image based on an `MGLMapView` object's style, camera, and view bounds. diff --git a/platform/darwin/src/MGLOfflineStorage.h b/platform/darwin/src/MGLOfflineStorage.h index 0b2b5221cf..628a05927e 100644 --- a/platform/darwin/src/MGLOfflineStorage.h +++ b/platform/darwin/src/MGLOfflineStorage.h @@ -28,7 +28,7 @@ NS_ASSUME_NONNULL_BEGIN path. #### Related examples - See the + See the Download an offline map example to learn how to calculate the progress of an offline download. */ @@ -184,7 +184,7 @@ typedef NS_ENUM(NSUInteger, MGLResourceKind) { maintains a canonical collection of offline packs in its `packs` property. #### Related examples - See the + See the Download an offline map example to learn how to create and register an offline pack for a defined region. */ diff --git a/platform/darwin/src/MGLPointAnnotation.h b/platform/darwin/src/MGLPointAnnotation.h index 0543d57691..27562f0df0 100644 --- a/platform/darwin/src/MGLPointAnnotation.h +++ b/platform/darwin/src/MGLPointAnnotation.h @@ -36,9 +36,9 @@ NS_ASSUME_NONNULL_BEGIN in GeoJSON. #### Related examples - See the - Mark a place on the map with an annotation, - Mark a place on the map with an image, and + See the + Mark a place on the map with an annotation, + Mark a place on the map with an image, and Default callout usage examples to learn how to add `MGLPointAnnotation` objects to your map. */ diff --git a/platform/darwin/src/MGLPolygon.h b/platform/darwin/src/MGLPolygon.h index fcc26e5f16..900e43334e 100644 --- a/platform/darwin/src/MGLPolygon.h +++ b/platform/darwin/src/MGLPolygon.h @@ -46,7 +46,7 @@ NS_ASSUME_NONNULL_BEGIN than −180 degrees or greater than 180 degrees. #### Related examples - See the + See the Add a polygon annotation example to learn how to initialize an `MGLPolygon` object from an array of coordinates. */ diff --git a/platform/darwin/src/MGLPolyline.h b/platform/darwin/src/MGLPolyline.h index 7b81d41f47..9efaea24ff 100644 --- a/platform/darwin/src/MGLPolyline.h +++ b/platform/darwin/src/MGLPolyline.h @@ -52,7 +52,7 @@ NS_ASSUME_NONNULL_BEGIN geometry in GeoJSON. #### Related examples - See the + See the Annotation models example to learn how to add an `MGLPolyine` object to your map. */ diff --git a/platform/darwin/src/MGLRasterTileSource.h b/platform/darwin/src/MGLRasterTileSource.h index 5d7e3e64fa..110ad875b5 100644 --- a/platform/darwin/src/MGLRasterTileSource.h +++ b/platform/darwin/src/MGLRasterTileSource.h @@ -54,7 +54,7 @@ FOUNDATION_EXTERN MGL_EXPORT const MGLTileSourceOption MGLTileSourceOptionTileSi ``` #### Related examples - See the + See the Add raster imagery example to learn how to add a `MGLRasterStyleLayer` to your map using an `MGLRasterTileSource`. */ diff --git a/platform/darwin/src/MGLShapeSource.h b/platform/darwin/src/MGLShapeSource.h index b910fb02ce..009e8652c9 100644 --- a/platform/darwin/src/MGLShapeSource.h +++ b/platform/darwin/src/MGLShapeSource.h @@ -27,7 +27,7 @@ typedef NSString *MGLShapeSourceOption NS_STRING_ENUM; is ignored when creating an `MGLComputedShapeSource` object. #### Related examples - See the Cluster point data and Use images to cluster point data examples to learn how to cluster point data with this `MGLShapeSourceOption`. + See the Cluster point data and Use images to cluster point data examples to learn how to cluster point data with this `MGLShapeSourceOption`. */ FOUNDATION_EXTERN MGL_EXPORT const MGLShapeSourceOption MGLShapeSourceOptionClustered; @@ -149,7 +149,7 @@ FOUNDATION_EXTERN MGL_EXPORT const MGLShapeSourceOption MGLShapeSourceOptionLine ``` #### Related examples - See the Cluster point data, Use images to cluster point data, and Add live data examples to learn how to add data to your map using this `MGLSource` object. + See the Cluster point data, Use images to cluster point data, and Add live data examples to learn how to add data to your map using this `MGLSource` object. */ MGL_EXPORT @interface MGLShapeSource : MGLSource @@ -175,7 +175,7 @@ MGL_EXPORT @return An initialized shape source. #### Related examples - See the + See the Add live data example to learn how to add live data to your map by updating the an `MGLShapeSource` object's `URL` property. */ @@ -209,7 +209,7 @@ MGL_EXPORT @return An initialized shape source. #### Related examples - See the + See the Animate a line example to learn how to animate line data by continously updating an `MGLShapeSource`'s `shape` attribute. */ diff --git a/platform/darwin/src/MGLStyle.h b/platform/darwin/src/MGLStyle.h index 084d18ad22..1ab0f5e82e 100644 --- a/platform/darwin/src/MGLStyle.h +++ b/platform/darwin/src/MGLStyle.h @@ -54,7 +54,7 @@ FOUNDATION_EXTERN MGL_EXPORT MGLExceptionName const MGLRedundantSourceIdentifier that it's safe to modify the map's style. #### Related examples - See the + See the Default styles example to learn how to initialize an `MGLMapView` object with a Mapbox default style using `MGLStyle`'s class methods. */ @@ -184,7 +184,7 @@ MGL_EXPORT significantly from version to version. #### Related example - See the + See the Satellite styles example to learn how to initialize a map with the Mapbox Satellite style. */ @@ -220,7 +220,7 @@ MGL_EXPORT change significantly from version to version. #### Related example - See the + See the Satellite styles example to learn how to initialize a map with the Mapbox Satellite Streets style. */ @@ -426,7 +426,7 @@ MGL_EXPORT @param sibling An existing layer in the style. #### Related examples - See the + See the Add multiple shapes from a single shape source example to learn how to add a layer to your map below an existing layer. */ @@ -451,7 +451,7 @@ MGL_EXPORT @param sibling An existing layer in the style. #### Related examples - See the + See the Add an image example to learn how to add a layer to your map above an existing layer. */ @@ -514,8 +514,8 @@ MGL_EXPORT @param name The name of the image to set to the style. #### Related examples - See the - Use images to cluster point data and + See the + Use images to cluster point data and Cluster point data examples to learn how to add images to your map using an `MGLStyle` object. */ diff --git a/platform/darwin/src/MGLStyleLayer.h b/platform/darwin/src/MGLStyleLayer.h index 878d7cdbba..785a8db7b3 100644 --- a/platform/darwin/src/MGLStyleLayer.h +++ b/platform/darwin/src/MGLStyleLayer.h @@ -45,7 +45,7 @@ MGL_EXPORT Whether this layer is displayed. A value of `NO` hides the layer. #### Related examples - See the + See the Show and hide a layer example to learn how to toggle an `MGLStyleLayer` object's visibility. */ diff --git a/platform/darwin/src/MGLTilePyramidOfflineRegion.h b/platform/darwin/src/MGLTilePyramidOfflineRegion.h index 7d1f2f511b..162636eda0 100644 --- a/platform/darwin/src/MGLTilePyramidOfflineRegion.h +++ b/platform/darwin/src/MGLTilePyramidOfflineRegion.h @@ -14,7 +14,7 @@ NS_ASSUME_NONNULL_BEGIN use the MGLShapeOfflineRegion class instead. #### Related examples - See the + See the Download an offline map example to learn how to define an offline region to be downloaded to a user's device. */ diff --git a/platform/darwin/src/MGLVectorTileSource.h b/platform/darwin/src/MGLVectorTileSource.h index 56fee440c8..53de9dbc2a 100644 --- a/platform/darwin/src/MGLVectorTileSource.h +++ b/platform/darwin/src/MGLVectorTileSource.h @@ -55,7 +55,7 @@ NS_ASSUME_NONNULL_BEGIN ``` #### Related examples - See the + See the Data-driven circles example to learn how to add data to your map using an `MGLVectorTileSource` object. */ diff --git a/platform/darwin/src/NSExpression+MGLAdditions.h b/platform/darwin/src/NSExpression+MGLAdditions.h index e4b83f0386..1e6fd6fc46 100644 --- a/platform/darwin/src/NSExpression+MGLAdditions.h +++ b/platform/darwin/src/NSExpression+MGLAdditions.h @@ -114,9 +114,9 @@ FOUNDATION_EXTERN MGL_EXPORT const MGLExpressionInterpolationMode MGLExpressionI @param stops The stops must be an `NSDictionary` constant `NSExpression`. #### Related examples - See the - Data-driven circles, - Cluster point data, and + See the + Data-driven circles, + Cluster point data, and Use images to cluster point data examples to learn how to use this expression to style a map layer based on an attribute value. */ @@ -134,7 +134,7 @@ FOUNDATION_EXTERN MGL_EXPORT const MGLExpressionInterpolationMode MGLExpressionI @param stops The stops expression. #### Related examples - See the + See the Create a heatmap layer example to learn how to style an `MGLHeatmapStyleLayer` based on zoom level and point density with this expression. */ diff --git a/platform/ios/DEVELOPING.md b/platform/ios/DEVELOPING.md index 394e7c2611..8dabc98a6f 100644 --- a/platform/ios/DEVELOPING.md +++ b/platform/ios/DEVELOPING.md @@ -59,7 +59,7 @@ To add any Objective-C type, constant, or member to the iOS SDK’s public inter 1. Ensure that the symbol is pure Objective-C and does not rely on any language features specific to Objective-C++ or the C11 dialect of C – so no namespaced types or classes named with emoji! 🙃 Most projects that depend on this SDK are either written in pure Objective-C (GNU99 dialect) or Swift, which cannot yet bridge C++ types. 1. Name the symbol according to [Cocoa naming conventions](https://developer.apple.com/library/prerelease/content/documentation/Cocoa/Conceptual/CodingGuidelines/CodingGuidelines.html#//apple_ref/doc/uid/10000146i). Use the `MGL` class prefix to avoid conflicts with client code. If the symbol has an analogue in MapKit, name the symbol according to MapKit. -1. Provide full documentation comments. We use [jazzy](https://github.com/realm/jazzy/) to produce the documentation found in the SDK distribution and [on the website for this SDK](https://www.mapbox.com/ios-sdk/api/). We also recognize that many developers rely on Xcode’s Quick Help feature. jazzy supports Markdown formatting; however, Quick Help supports only [HeaderDoc](https://developer.apple.com/legacy/library/documentation/DeveloperTools/Conceptual/HeaderDoc/intro/intro.html) syntax and a subset of Doxygen syntax. For hyperlinks, use HTML syntax, which is recognized by both tools. +1. Provide full documentation comments. We use [jazzy](https://github.com/realm/jazzy/) to produce the documentation found in the SDK distribution and [on the website for this SDK](https://docs.mapbox.com/ios/api/maps/). We also recognize that many developers rely on Xcode’s Quick Help feature. jazzy supports Markdown formatting; however, Quick Help supports only [HeaderDoc](https://developer.apple.com/legacy/library/documentation/DeveloperTools/Conceptual/HeaderDoc/intro/intro.html) syntax and a subset of Doxygen syntax. For hyperlinks, use HTML syntax, which is recognized by both tools. ### Making a type or constant public diff --git a/platform/ios/Integration Tests/MGLStyleLayerIntegrationTests.m b/platform/ios/Integration Tests/MGLStyleLayerIntegrationTests.m index 31c494b7d5..9933f0312b 100644 --- a/platform/ios/Integration Tests/MGLStyleLayerIntegrationTests.m +++ b/platform/ios/Integration Tests/MGLStyleLayerIntegrationTests.m @@ -6,7 +6,7 @@ @implementation MGLStyleLayerIntegrationTests - (MGLCircleStyleLayer*)setupCircleStyleLayer { - // Adapted from https://www.mapbox.com/ios-sdk/examples/dds-circle-layer/ + // Adapted from https://docs.mapbox.com/ios/examples/dds-circle-layer/ // "mapbox://examples.2uf7qges" is a map ID referencing a tileset. For more // more information, see docs.mapbox.com/help/glossary/map-id/ @@ -23,7 +23,7 @@ - (void)testForInterpolatingExpressionRenderCrashWithEmptyStops { // Tests: https://github.com/mapbox/mapbox-gl-native/issues/9539 - // Adapted from https://www.mapbox.com/ios-sdk/examples/dds-circle-layer/ + // Adapted from https://docs.mapbox.com/ios/examples/dds-circle-layer/ self.mapView.centerCoordinate = CLLocationCoordinate2DMake(38.897,-77.039); self.mapView.zoomLevel = 10.5; @@ -42,7 +42,7 @@ - (void)testForSteppingExpressionRenderCrashWithEmptyStops { // Tests: https://github.com/mapbox/mapbox-gl-native/issues/9539 - // Adapted from https://www.mapbox.com/ios-sdk/examples/dds-circle-layer/ + // Adapted from https://docs.mapbox.com/ios/examples/dds-circle-layer/ self.mapView.centerCoordinate = CLLocationCoordinate2DMake(38.897,-77.039); self.mapView.zoomLevel = 10.5; diff --git a/platform/ios/Mapbox-iOS-SDK-nightly-dynamic.podspec b/platform/ios/Mapbox-iOS-SDK-nightly-dynamic.podspec index c3237601cc..f1b9eee2a6 100644 --- a/platform/ios/Mapbox-iOS-SDK-nightly-dynamic.podspec +++ b/platform/ios/Mapbox-iOS-SDK-nightly-dynamic.podspec @@ -7,12 +7,12 @@ Pod::Spec.new do |m| m.summary = 'Open source vector map solution for iOS with full styling capabilities.' m.description = 'Open source, OpenGL-based vector map solution for iOS with full styling capabilities and Cocoa Touch APIs.' - m.homepage = 'https://www.mapbox.com/ios-sdk/' + m.homepage = 'https://docs.mapbox.com/ios/maps/' m.license = { :type => 'BSD', :file => 'LICENSE.md' } m.author = { 'Mapbox' => 'mobile@mapbox.com' } - m.screenshot = "https://www.mapbox.com/ios-sdk/api/#{version}/img/screenshot.png" + m.screenshot = "https://docs.mapbox.com/ios/api/maps/#{version}/img/screenshot.png" m.social_media_url = 'https://twitter.com/mapbox' - m.documentation_url = 'https://www.mapbox.com/ios-sdk/api/' + m.documentation_url = 'https://docs.mapbox.com/ios/api/maps/' m.source = { :http => "https://mapbox.s3.amazonaws.com/mapbox-gl-native/ios/builds/mapbox-ios-sdk-nightly-dynamic.zip", diff --git a/platform/ios/Mapbox-iOS-SDK-stripped.podspec b/platform/ios/Mapbox-iOS-SDK-stripped.podspec index 20bee73e80..289bf43b36 100644 --- a/platform/ios/Mapbox-iOS-SDK-stripped.podspec +++ b/platform/ios/Mapbox-iOS-SDK-stripped.podspec @@ -7,12 +7,12 @@ Pod::Spec.new do |m| m.summary = 'Open source vector map solution for iOS with full styling capabilities.' m.description = 'Open source, OpenGL-based vector map solution for iOS with full styling capabilities and Cocoa Touch APIs.' - m.homepage = 'https://www.mapbox.com/ios-sdk/' + m.homepage = 'https://docs.mapbox.com/ios/maps/' m.license = { :type => 'BSD', :file => 'LICENSE.md' } m.author = { 'Mapbox' => 'mobile@mapbox.com' } - m.screenshot = "https://www.mapbox.com/ios-sdk/api/#{version}/img/screenshot.png" + m.screenshot = "https://docs.mapbox.com/ios/api/maps/#{version}/img/screenshot.png" m.social_media_url = 'https://twitter.com/mapbox' - m.documentation_url = 'https://www.mapbox.com/ios-sdk/api/' + m.documentation_url = 'https://docs.mapbox.com/ios/api/maps/' m.source = { :http => "https://mapbox.s3.amazonaws.com/mapbox-gl-native/ios/builds/mapbox-ios-sdk-#{m.version.to_s}-dynamic.zip", diff --git a/platform/ios/Mapbox-iOS-SDK.podspec b/platform/ios/Mapbox-iOS-SDK.podspec index e5179c9263..9bd5b0740c 100644 --- a/platform/ios/Mapbox-iOS-SDK.podspec +++ b/platform/ios/Mapbox-iOS-SDK.podspec @@ -7,12 +7,12 @@ Pod::Spec.new do |m| m.summary = 'Open source vector map solution for iOS with full styling capabilities.' m.description = 'Open source, OpenGL-based vector map solution for iOS with full styling capabilities and Cocoa Touch APIs.' - m.homepage = 'https://www.mapbox.com/ios-sdk/' + m.homepage = 'https://docs.mapbox.com/ios/maps/' m.license = { :type => 'BSD', :file => 'LICENSE.md' } m.author = { 'Mapbox' => 'mobile@mapbox.com' } - m.screenshot = "https://www.mapbox.com/ios-sdk/api/#{version}/img/screenshot.png" + m.screenshot = "https://docs.mapbox.com/ios/api/maps/#{version}/img/screenshot.png" m.social_media_url = 'https://twitter.com/mapbox' - m.documentation_url = 'https://www.mapbox.com/ios-sdk/api/' + m.documentation_url = 'https://docs.mapbox.com/ios/api/maps/' m.source = { :http => "https://mapbox.s3.amazonaws.com/mapbox-gl-native/ios/builds/mapbox-ios-sdk-#{m.version.to_s}-dynamic.zip", diff --git a/platform/ios/README.md b/platform/ios/README.md index 27c8ad4cc8..fe6f3be95d 100644 --- a/platform/ios/README.md +++ b/platform/ios/README.md @@ -1,10 +1,10 @@ -# [Mapbox Maps SDK for iOS](https://www.mapbox.com/ios-sdk/) +# [Mapbox Maps SDK for iOS](https://docs.mapbox.com/ios/maps/) [![Circle CI build status](https://circleci.com/gh/mapbox/mapbox-gl-native.svg?style=shield)](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master) A library based on [Mapbox GL Native](../../README.md) for embedding interactive map views with scalable, customizable vector maps into Cocoa Touch applications on iOS using Objective-C, Swift, or Interface Builder. -This repository is for day-to-day development of the SDK. Building the SDK yourself requires [a number of dependencies and steps](../../INSTALL.md) that are unnecessary for developing production applications. For production applications, please consider installing an official, prebuilt release instead; see the [Mapbox iOS SDK website](https://www.mapbox.com/ios-sdk/) for installation instructions. +This repository is for day-to-day development of the SDK. Building the SDK yourself requires [a number of dependencies and steps](../../INSTALL.md) that are unnecessary for developing production applications. For production applications, please consider installing an official, prebuilt release instead; see the [Mapbox Maps SDK for iOS website](https://docs.mapbox.com/ios/maps/) for installation instructions. * [Integrate the Mapbox Maps SDK for iOS into your application](https://www.mapbox.com/install/ios/). * [Learn about custom builds](INSTALL.md) diff --git a/platform/ios/jazzy.yml b/platform/ios/jazzy.yml index 31381650da..d459e93613 100644 --- a/platform/ios/jazzy.yml +++ b/platform/ios/jazzy.yml @@ -2,7 +2,7 @@ module: Mapbox author: Mapbox author_url: https://www.mapbox.com/ github_url: https://github.com/mapbox/mapbox-gl-native -dash_url: https://www.mapbox.com/ios-sdk/docsets/Mapbox.xml +dash_url: https://docs.mapbox.com/ios/docsets/Mapbox.xml copyright: '© 2014–2019 [Mapbox](https://www.mapbox.com/). See [license](https://github.com/mapbox/mapbox-gl-native/blob/master/LICENSE.md) for more details.' head: | diff --git a/platform/ios/scripts/document.sh b/platform/ios/scripts/document.sh index 99c8967aa1..ec307445af 100755 --- a/platform/ios/scripts/document.sh +++ b/platform/ios/scripts/document.sh @@ -55,7 +55,7 @@ jazzy \ --module-version ${SHORT_VERSION} \ --readme ${README} \ --documentation="platform/{darwin,ios}/docs/guides/*.md" \ - --root-url https://www.mapbox.com/ios-sdk/api/${RELEASE_VERSION}/ \ + --root-url https://docs.mapbox.com/ios/api/maps/${RELEASE_VERSION}/ \ --theme ${THEME} \ --output ${OUTPUT} diff --git a/platform/ios/src/MGLAnnotationImage.h b/platform/ios/src/MGLAnnotationImage.h index fd76a9b43a..10b13a58c3 100644 --- a/platform/ios/src/MGLAnnotationImage.h +++ b/platform/ios/src/MGLAnnotationImage.h @@ -11,7 +11,7 @@ NS_ASSUME_NONNULL_BEGIN by the map view. #### Related examples - See the + See the Mark a place on the map with an image example to learn how use an image as a marker using `MGLAnnotationImage`. */ diff --git a/platform/ios/src/MGLAnnotationView.h b/platform/ios/src/MGLAnnotationView.h index 61fd22f1c2..afedeb7908 100644 --- a/platform/ios/src/MGLAnnotationView.h +++ b/platform/ios/src/MGLAnnotationView.h @@ -224,7 +224,7 @@ MGL_EXPORT change is immediate. #### Related examples - See the Annotation views example to learn how to modify an `MGLAnnotationView`'s behavior when it is selected. */ @@ -257,7 +257,7 @@ MGL_EXPORT continue to completion. #### Related examples - See the Draggable annotation views to learn how to enable users to drag `MGLAnnotationView` objects on your map. */ diff --git a/platform/ios/src/MGLCalloutView.h b/platform/ios/src/MGLCalloutView.h index 7b2177fdd5..a5868ac102 100644 --- a/platform/ios/src/MGLCalloutView.h +++ b/platform/ios/src/MGLCalloutView.h @@ -13,7 +13,7 @@ NS_ASSUME_NONNULL_BEGIN use the optional methods available in the `MGLCalloutViewDelegate` protocol. #### Related examples - See the + See the Display custom views as callouts example to learn how to customize an `MGLCalloutView`. */ diff --git a/platform/ios/src/MGLMapView.h b/platform/ios/src/MGLMapView.h index 6e3380553d..cad35c81d8 100644 --- a/platform/ios/src/MGLMapView.h +++ b/platform/ios/src/MGLMapView.h @@ -53,7 +53,9 @@ typedef NS_ENUM(NSUInteger, MGLAnnotationVerticalAlignment) { `MGLMapView.userTrackingMode`. #### Related examples - See the Switch between user tracking modes example to learn how to toggle modes and how each mode behaves. + See the + Switch between user tracking modes example to learn how to toggle modes and + how each mode behaves. */ typedef NS_ENUM(NSUInteger, MGLUserTrackingMode) { /** The map does not follow the user location. */ @@ -156,7 +158,7 @@ FOUNDATION_EXTERN MGL_EXPORT MGLExceptionName const MGLResourceNotFoundException ensuring that your use adheres to the relevant terms of use. #### Related examples - See the + See the Simple map view example to learn how to initialize a basic `MGLMapView`. */ MGL_EXPORT IB_DESIGNABLE @@ -185,13 +187,14 @@ MGL_EXPORT IB_DESIGNABLE @return An initialized map view. #### Related examples - See the + See the Apply a style designed in Mapbox Studio example to learn how to - initialize an `MGLMapView` with a custom style. See the - Appy a style designed in Mapbox Studio Classic example to learn how to - intialize an `MGLMapView` with a Studio Classic style _or_ a custom style - JSON. See the - Use third-party vector tiles example to learn how to initialize an + initialize an `MGLMapView` with a custom style. See the + Apply a + style designed in Mapbox Studio Classic example to learn how to intialize + an `MGLMapView` with a Studio Classic style _or_ a custom style JSON. See the + Use + third-party vector tiles example to learn how to initialize an `MGLMapView` with a third-party tile source. */ - (instancetype)initWithFrame:(CGRect)frame styleURL:(nullable NSURL *)styleURL; @@ -248,7 +251,7 @@ MGL_EXPORT IB_DESIGNABLE you want to introspect individual style attributes, use the `style` property. #### Related examples - See the + See the Switch between map styles example to learn how to change the style of a map at runtime. */ @@ -421,7 +424,7 @@ MGL_EXPORT IB_DESIGNABLE `-setUserTrackingMode:animated:` method instead. #### Related examples - See the + See the Customize the user location annotation to learn how to customize the default user location annotation shown by `MGLUserTrackingMode`. */ @@ -918,7 +921,7 @@ MGL_EXPORT IB_DESIGNABLE immediately. #### Related examples - See the + See the Camera animation example to learn how to trigger an animation that rotates around a central point. */ @@ -937,7 +940,7 @@ MGL_EXPORT IB_DESIGNABLE is `0`, this parameter is ignored. #### Related examples - See the + See the Camera animation example to learn how to create a timed animation that rotates around a central point for a specific duration. */ @@ -1185,7 +1188,7 @@ MGL_EXPORT IB_DESIGNABLE @return The geographic coordinate at the given point. #### Related examples - See the + See the Point conversion example to learn how to convert a `CGPoint` to a map coordinate. */ @@ -1204,7 +1207,7 @@ MGL_EXPORT IB_DESIGNABLE corresponding to the given geographic coordinate. #### Related examples - See the + See the Point conversion example to learn how to convert a map coordinate to a `CGPoint` object. */ @@ -1281,8 +1284,8 @@ MGL_EXPORT IB_DESIGNABLE annotation object. #### Related examples - See the - Annotation models and + See the + Annotation models and Add a line annotation from GeoJSON examples to learn how to add an annotation to an `MGLMapView` object. */ @@ -1352,7 +1355,7 @@ MGL_EXPORT IB_DESIGNABLE such object exists in the reuse queue. #### Related examples - See the + See the Add annotation views and images example learn how to most efficiently reuse an `MGLAnnotationImage`. */ @@ -1517,7 +1520,7 @@ MGL_EXPORT IB_DESIGNABLE represent features in the sources used by the current style. #### Related examples - See the + See the Select a feature within a layer example to learn how to query an `MGLMapView` object for visible `MGLFeature` objects. */ diff --git a/platform/ios/src/MGLMapViewDelegate.h b/platform/ios/src/MGLMapViewDelegate.h index ffc460b995..e9f864f370 100644 --- a/platform/ios/src/MGLMapViewDelegate.h +++ b/platform/ios/src/MGLMapViewDelegate.h @@ -43,7 +43,7 @@ NS_ASSUME_NONNULL_BEGIN `oldCamera` or change to `newCamera`. #### Related examples - See the + See the Restrict map panning to an area example to learn how to use this method and `MGLMapCamera` objects to restrict a users ability to pan your map. */ @@ -116,7 +116,7 @@ NS_ASSUME_NONNULL_BEGIN @param mapView The map view whose viewpoint is changing. #### Related examples - See the + See the Cluster point data example to learn how to trigger an action whenever the map region changes. */ @@ -268,8 +268,8 @@ NS_ASSUME_NONNULL_BEGIN @param style The style that was loaded. #### Related examples - See the - Dynamically style interactive points and + See the + Dynamically style interactive points and Add multiple shapes from a single shape source examples to learn how to ensure a map's style has loaded before modifying it at runtime. */ @@ -374,9 +374,9 @@ NS_ASSUME_NONNULL_BEGIN `nil` if you want to display the default marker image or an annotation view. #### Related examples - See the - Annotation models, - Add annotation views and images, and + See the + Annotation models, + Add annotation views and images, and Mark a place on the map with an image examples to learn to specify which image should be used for `MGLAnnotation` objects that have been added to your map. @@ -414,7 +414,7 @@ NS_ASSUME_NONNULL_BEGIN @return A color to use for the shape outline. #### Related examples - See the + See the Annotation models example to learn how to modify the outline color of an `MGLShape` object that has been added to your map as an annotation. */ @@ -434,7 +434,7 @@ NS_ASSUME_NONNULL_BEGIN @return The polygon’s interior fill color. #### Related examples - See the Add + See the Add a polygon annotation example to learn how to modify the color of a an `MGLPolygon` at runtime. */ @@ -451,7 +451,7 @@ NS_ASSUME_NONNULL_BEGIN @return A line width for the polyline, measured in points. #### Related examples - See the + See the Add a line annotation from GeoJSON example to learn how to modify the line width of an `MGLPolylineFeature` on your map. */ @@ -483,7 +483,7 @@ NS_ASSUME_NONNULL_BEGIN want to display an annotation image instead. #### Related examples - See the + See the Add annotation views and images example to learn how to specify what `MGLViewAnnotation` to use for a given `MGLPointAnnotation` object on your map. @@ -530,7 +530,7 @@ NS_ASSUME_NONNULL_BEGIN @param annotation The annotation that was selected. #### Related examples - See the + See the Dynamically style interactive points example to learn how to remove an annotation view if it has already been selected. */ @@ -609,9 +609,9 @@ NS_ASSUME_NONNULL_BEGIN callout. #### Related examples - See the - Add annotation views and images, - Display custom views as callouts, and + See the + Add annotation views and images, + Display custom views as callouts, and Default callout usage examples to learn how to show callouts for `MGLAnnotation` objects. */ @@ -633,7 +633,7 @@ NS_ASSUME_NONNULL_BEGIN default callout view. #### Related examples - See the + See the Display custom views as callouts example to learn how to customize an `MGLAnnotation` object's `MGLCalloutView`. */ @@ -664,7 +664,7 @@ NS_ASSUME_NONNULL_BEGIN @return The accessory view to display. #### Related examples - See the + See the Default callout usage example to learn how to modify the view that is displayed on the left side of the standard callout bubble. */ @@ -695,7 +695,7 @@ NS_ASSUME_NONNULL_BEGIN @return The accessory view to display. #### Related examples - See the + See the Default callout usage example to learn how to modify the view that is displayed on the right side of the standard callout bubble. */ @@ -725,7 +725,7 @@ NS_ASSUME_NONNULL_BEGIN @param control The control that was tapped. #### Related examples - See the + See the Default callout usage example to learn how to trigger an action when the standard callout bubble's accessory control is tapped. */ @@ -748,7 +748,7 @@ NS_ASSUME_NONNULL_BEGIN @param annotation The annotation whose callout was tapped. #### Related examples - See the + See the Display custom views as callouts example to learn how to trigger an action when an `MGLAnnotation`s `MGLCalloutView` is tapped. */ diff --git a/platform/ios/src/MGLMapboxEvents.m b/platform/ios/src/MGLMapboxEvents.m index e9f27b3446..0635f974e1 100644 --- a/platform/ios/src/MGLMapboxEvents.m +++ b/platform/ios/src/MGLMapboxEvents.m @@ -189,7 +189,7 @@ static NSString * const MGLVariableGeofence = @"VariableGeofence"; @"End users must be able to opt out of Mapbox Telemetry in your app, either inside Settings (via Settings.bundle) or inside this app. " @"By default, this opt-out control is included as a menu item in the attribution action sheet. " @"If you reimplement the opt-out control inside this app, disable this assertion by setting MGLMapboxMetricsEnabledSettingShownInApp to YES in Info.plist." - @"\n\nSee https://www.mapbox.com/ios-sdk/#telemetry_opt_out for more information." + @"\n\nSee https://docs.mapbox.com/help/how-mapbox-works/attribution/#mapbox-maps-sdk-for-ios for more information." @"\n\nAdditionally, by hiding this attribution control you agree to display the required attribution elsewhere in this app."]; } } diff --git a/platform/ios/src/MGLUserLocation.h b/platform/ios/src/MGLUserLocation.h index de720d9050..d7c8576c47 100644 --- a/platform/ios/src/MGLUserLocation.h +++ b/platform/ios/src/MGLUserLocation.h @@ -13,7 +13,9 @@ NS_ASSUME_NONNULL_BEGIN `userLocation` property of the map view displayed in your application. #### Related examples - See the Customize the user location annotation example to learn how to overide the default user location annotation. + See the + Customize the user location annotation example to learn how to overide the + default user location annotation. */ MGL_EXPORT @interface MGLUserLocation : NSObject diff --git a/platform/ios/src/MGLUserLocationAnnotationView.h b/platform/ios/src/MGLUserLocationAnnotationView.h index 573fb9f95f..f5197b9f76 100644 --- a/platform/ios/src/MGLUserLocationAnnotationView.h +++ b/platform/ios/src/MGLUserLocationAnnotationView.h @@ -27,7 +27,7 @@ MGL_EXPORT is inactive. #### Related examples - See the + See the Customize the user location annotation example to learn how to customize the default user location annotation object. */ diff --git a/platform/macos/docs/pod-README.md b/platform/macos/docs/pod-README.md index 5dbef70efb..6fd0926443 100644 --- a/platform/macos/docs/pod-README.md +++ b/platform/macos/docs/pod-README.md @@ -6,7 +6,7 @@ Put interactive, scalable world maps into your native Cocoa application with the * Customize every aspect of the map’s appearance in code or visually using [Mapbox Studio](https://www.mapbox.com/mapbox-studio/). * High-performance OpenGL rendering and multitouch gestures keep your users happy. * A well-designed, fully documented API helps you stay productive. -* Develop across [multiple platforms](https://www.mapbox.com/maps/), including [iOS](https://www.mapbox.com/ios-sdk/), using the same styles and similar APIs. +* Develop across [multiple platforms](https://www.mapbox.com/maps/), including [iOS](https://docs.mapbox.com/ios/maps/), using the same styles and similar APIs. ![](https://raw.githubusercontent.com/mapbox/mapbox-gl-native/master/platform/macos/docs/img/screenshot.jpg) @@ -93,6 +93,6 @@ script AppDelegate end script ``` -Full API documentation is included in this package, within the `documentation` folder, and [online](https://mapbox.github.io/mapbox-gl-native/macos/). The [Mapbox Maps SDK for iOS](https://www.mapbox.com/ios-sdk/) has [API documentation](https://www.mapbox.com/ios-sdk/api/) and [online examples](https://www.mapbox.com/ios-sdk/examples/) that apply to the Mapbox Maps SDK for macOS with few differences, mostly around unimplemented features like user location tracking. +Full API documentation is included in this package, within the `documentation` folder, and [online](https://mapbox.github.io/mapbox-gl-native/macos/). The [Mapbox Maps SDK for iOS](https://docs.mapbox.com/ios/maps/) has [API documentation](https://docs.mapbox.com/ios/api/maps/) and [online examples](https://docs.mapbox.com/ios/maps/examples/) that apply to the Mapbox Maps SDK for macOS with few differences, mostly around unimplemented features like user location tracking. Mapbox does not officially support the macOS SDK to the same extent as the iOS SDK; however, [bug reports and pull requests](https://github.com/mapbox/mapbox-gl-native/issues/) are certainly welcome. -- cgit v1.2.1