[ios,macos] add Info.plist key guides

mapbox · Oct 26, 2016 · 0964964 · 0964964
1 parent 01a67a4
commit 0964964
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 0 deletions.
diff --git a/platform/ios/Info.plist Keys.md b/platform/ios/Info.plist Keys.md
@@ -0,0 +1,15 @@
+# Info.plist Keys
+
+The SDK supports several custom `Info.plist` keys in your application in order to configure various settings. 
+
+## MGLMapboxAccessToken
+
+Use this key to set your Mapbox API [access token](https://www.mapbox.com/help/define-access-token/). This key is required for all map use. 
+
+## MGLMapboxAPIBaseURL
+
+Use this key if you need to customize the API base URL used throughout the SDK. If unset, the default Mapbox API is used. 
+
+## MGLMapboxMetricsEnabledSettingShownInApp
+
+If you have implemented custom opt-out of Mapbox Telemetry within the user interface of your app, use this key to disable the built-in check for opt-out support. See [this guide](https://www.mapbox.com/ios-sdk/#telemetry_opt_out) for more details.
diff --git a/platform/ios/scripts/document.sh b/platform/ios/scripts/document.sh
@@ -38,6 +38,7 @@ jazzy \
     --github-file-prefix https://github.com/mapbox/mapbox-gl-native/tree/${BRANCH} \
     --module-version ${SHORT_VERSION} \
     --readme ${README} \
+    --documentation="platform/ios/Info.plist Keys.md" \
     --root-url https://www.mapbox.com/ios-sdk/api/${RELEASE_VERSION}/ \
     --theme platform/darwin/docs/theme \
     --output ${OUTPUT}

diff --git a/platform/macos/Info.plist Keys.md b/platform/macos/Info.plist Keys.md
@@ -0,0 +1,11 @@
+# Info.plist Keys
+
+The Mapbox macOS SDK supports custom `Info.plist` keys in your application in order to configure various settings. 
+
+## MGLMapboxAccessToken
+
+Use this key to set your Mapbox API [access token](https://www.mapbox.com/help/define-access-token/). This key is required for all map use. 
+
+## MGLMapboxAPIBaseURL
+
+Use this key if you need to customize the API base URL used throughout the SDK. If unset, the default Mapbox API is used. 
diff --git a/platform/macos/scripts/document.sh b/platform/macos/scripts/document.sh
@@ -38,6 +38,7 @@ jazzy \
     --github-file-prefix https://github.com/mapbox/mapbox-gl-native/tree/${BRANCH} \
     --module-version ${SHORT_VERSION} \
     --readme ${README} \
+    --documentation="platform/macos/Info.plist Keys.md" \
     --theme platform/darwin/docs/theme \
     --output ${OUTPUT}
 # https://github.com/realm/jazzy/issues/411