diff options
| author | Minh Nguyễn <mxn@1ec5.org> | 2015-12-06 15:24:58 -0800 |
|---|---|---|
| committer | Minh Nguyễn <mxn@1ec5.org> | 2016-01-05 12:41:54 -0800 |
| commit | 1420a49689c3b48dd429fb5a3640596a9e7c9623 (patch) | |
| tree | 4acf7523051ede1230439d6fbb099dadf411f334 /platform/ios/INSTALL.md | |
| parent | e26b218883c3357f38dd8ff5490b453dabffc590 (diff) | |
| download | qtlocation-mapboxgl-1420a49689c3b48dd429fb5a3640596a9e7c9623.tar.gz | |
[ios] Generate API documentation using jazzy
Replaced appledoc usage with jazzy, which understands modern Objective-C syntax by virtue of using Clang ASTs. Nevertheless, we have to make lots of changes to our documentation syntax, which was tailored to appledocs quirks. The new syntax jives much better with what Xcode expects in terms of auto-indentation and Quick Help.
Fixes #1420.
Diffstat (limited to 'platform/ios/INSTALL.md')
| -rw-r--r-- | platform/ios/INSTALL.md | 7 |
1 files changed, 2 insertions, 5 deletions
diff --git a/platform/ios/INSTALL.md b/platform/ios/INSTALL.md index f3afaea822..2c36b5953c 100644 --- a/platform/ios/INSTALL.md +++ b/platform/ios/INSTALL.md @@ -14,13 +14,10 @@ The Mapbox iOS SDK and iosapp demo application build against the iOS 7.0 SDK. Th 1. [Install core dependencies](../../INSTALL.md). -1. Install [appledoc](http://appledoc.gentlebytes.com/appledoc/) for API docs generation. +1. Install [jazzy](https://github.com/realm/jazzy) for generating API documentation: ``` - curl -L -o appledoc.zip https://github.com/tomaz/appledoc/releases/download/v2.2-963/appledoc.zip - unzip appledoc.zip - cp appledoc /usr/local/bin - cp -Rf Templates/ ~/.appledoc + [sudo] gem install jazzy ``` 1. Run `make ipackage`. The packaging script will produce the statically-linked `libMapbox.a`, `Mapbox.bundle` for resources, a `Headers` folder, and a `Docs` folder with HTML API documentation. |