CarPlay documentation#1714
Merged
Merged
Conversation
Contributor
Author
|
For the time being, to get the full docset, you need to:
|
Make the documentation podspec maximally compatible with the codebase by adding the CarPlay and MapboxGeocoder frameworks as dependencies and increasing the minimum deployment target to iOS 12. When generating documentation, delete @available(iOS) attributes to prevent either jazzy or CocoaPods from eliding the associated symbols.
For better or worse, this codebase doesn’t use walls of asterisks.
More public CarPlay-related symbols are documented and refined for Objective-C.
5da6961 to
689cc32
Compare
akitchen
approved these changes
Sep 17, 2018
1ec5
commented
Sep 17, 2018
| find Mapbox{Core,}Navigation/ -name *.swift -exec \ | ||
| perl -pi -e 's/\@available\s*\(\s*iOS \d+.\d,.*?\)//' {} \; | ||
|
|
||
| ../jazzy/bin/jazzy \ |
Contributor
Author
There was a problem hiding this comment.
Doh, didn’t mean to commit this line. Fixed in cecb46e.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Classes and methods available only in certain iOS versions are now visible in the jazzy-generated docset. This includes all CarPlay-related symbols, which depend on iOS 12, as well as some symbols related to AVSpeechSynthesizer and Measurement that depend on iOS 10. To make this work, I had to strip out
@availableattributes. I haven’t fully investigated the root cause of the problem, but it seems to lie somewhere deep in a jazzy improvisation.Fleshed out documentation of public CarPlay-related symbols and refined their presentation in the docset’s table of contents and cover page. Deleted an old draft of a CarPlay getting started guide.
Added
@objcattributes to a number of CarPlay-related symbols to ensure compatibility with Objective-C code.Fixes #1682.
/cc @mapbox/navigation-ios @mapbox/docs