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 /.jazzy.yaml | |
| 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 '.jazzy.yaml')
| -rw-r--r-- | .jazzy.yaml | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/.jazzy.yaml b/.jazzy.yaml new file mode 100644 index 0000000000..35c4e9a8ec --- /dev/null +++ b/.jazzy.yaml @@ -0,0 +1,51 @@ +module_name: Mapbox +author_name: 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 +copyright: '© 2014–2015 [Mapbox](https://www.mapbox.com/). See [license](https://github.com/mapbox/mapbox-gl-native/blob/master/LICENSE.md) for more details.' + +custom_head: | + <link rel='shortcut icon' href='http://www.mapbox.com/img/favicon.ico' type='image/x-icon' /> + +objc_mode: Yes +skip_undocumented: Yes +hide_documentation_coverage: Yes +umbrella_header: include/mbgl/ios/Mapbox.h +framework_root: include/mbgl/darwin + +custom_categories: + - name: Map + children: + - MGLAccountManager + - MGLMapCamera + - MGLMapView + - MGLMapViewDelegate + - MGLStyle + - MGLUserTrackingMode + - name: Annotations + children: + - MGLAnnotation + - MGLAnnotationImage + - MGLMultiPoint + - MGLPointAnnotation + - MGLPolygon + - MGLPolyline + - MGLOverlay + - MGLShape + - MGLUserLocation + - name: Geometry + children: + - MGLCoordinateBounds + - MGLCoordinateBoundsEqualToCoordinateBounds + - MGLCoordinateBoundsGetCoordinateSpan + - MGLCoordinateBoundsIsEmpty + - MGLCoordinateBoundsMake + - MGLCoordinateBoundsOffset + - MGLCoordinateSpan + - MGLCoordinateSpanEqualToCoordinateSpan + - MGLCoordinateSpanMake + - MGLCoordinateSpanZero + - MGLDegreesFromRadians + - MGLRadiansFromDegrees + - MGLStringFromCoordinateBounds |