summaryrefslogtreecommitdiff
path: root/platform/macos/DEVELOPING.md
diff options
context:
space:
mode:
authorJason Wray <jason@mapbox.com>2016-08-17 15:30:39 -0400
committerJason Wray <jason@mapbox.com>2016-08-18 11:35:32 -0400
commit256689a33d465e8909e9bc5883ee3340551c7dca (patch)
tree13827aba761640fab50b8a56391699c4fbda99da /platform/macos/DEVELOPING.md
parent7de7f9dc918c3faf2dde3240698b76a97f3e8408 (diff)
downloadqtlocation-mapboxgl-256689a33d465e8909e9bc5883ee3340551c7dca.tar.gz
[ios, macos] Make Xcode 7.3 the minimum required version
- Removes nullability shims for Xcode 6. - Removes MGLTypes.h from files where it was only being used for nullability support. - Accepts that `NS_SWIFT_NAME` is not fully supported by Xcode 7.2 and lower. - Adds documentation about Xcode 7.3 requirement.
Diffstat (limited to 'platform/macos/DEVELOPING.md')
-rw-r--r--platform/macos/DEVELOPING.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/platform/macos/DEVELOPING.md b/platform/macos/DEVELOPING.md
index 5f437f4172..412a58a140 100644
--- a/platform/macos/DEVELOPING.md
+++ b/platform/macos/DEVELOPING.md
@@ -4,7 +4,9 @@ This document explains how to build the Mapbox macOS SDK from source. It is inte
## Requirements
-The Mapbox macOS SDK and the macosapp demo application run on macOS 10.10.0 and above.
+The Mapbox macOS SDK and the macosapp demo application run on macOS 10.10.0 or above.
+
+The Mapbox macOS SDK requires Xcode 7.3 or above.
## Building the SDK
@@ -34,6 +36,7 @@ To add an Objective-C class, protocol, category, typedef, enumeration, or global
To add an Objective-C header or implementation file to the macOS SDK:
1. Add the file to the “dynamic” target’s Headers or Compile Sources build phase, as appropriate. You can either use the Build Phases tab of the project editor or the Target Membership section of the File inspector.
+1. Audit new headers for nullability. Typically, you will wrap a header with `NS_ASSUME_NONNULL_BEGIN` and `NS_ASSUME_NONNULL_END`.
1. _(Optional.)_ If it’s a public header, change its visibility from Project to Public and import it in [the macOS SDK’s umbrella header](./src/Mapbox.h).
1. _(Optional.)_ If the file would also be used by the iOS SDK, make sure it’s in [platform/darwin/src/](../darwin/src/), then consult [the companion iOS document](../ios/DEVELOPING.md#adding-a-source-code-file) for further instructions.