summaryrefslogtreecommitdiff
path: root/platform/osx/jazzy.yml
diff options
context:
space:
mode:
authorMinh Nguyễn <mxn@1ec5.org>2016-05-09 16:03:16 -0700
committerMinh Nguyễn <mxn@1ec5.org>2016-05-10 09:59:04 -0700
commit5616cd2bb165bd50bed85ae58624642975fd1ba0 (patch)
treed31f4dc487537270ab8f5b82c2c3537886928cc2 /platform/osx/jazzy.yml
parent7332ae00735a7cb1a0a4528d48e5956aa593b8b8 (diff)
downloadqtlocation-mapboxgl-5616cd2bb165bd50bed85ae58624642975fd1ba0.tar.gz
[osx] Added OS X SDK documentation target
Added a target, script, and make rule for generating OS X SDK documentation with jazzy, along with a docset cover page. Switched the umbrella header from framework header syntax to user header syntax so SourceKit can find all the headers. Fixes #4871.
Diffstat (limited to 'platform/osx/jazzy.yml')
-rw-r--r--platform/osx/jazzy.yml71
1 files changed, 71 insertions, 0 deletions
diff --git a/platform/osx/jazzy.yml b/platform/osx/jazzy.yml
new file mode 100644
index 0000000000..b1aca9bb45
--- /dev/null
+++ b/platform/osx/jazzy.yml
@@ -0,0 +1,71 @@
+module: Mapbox
+author: Mapbox
+author_url: https://www.mapbox.com/
+github_url: https://github.com/mapbox/mapbox-gl-native
+copyright: '© 2014–2016 [Mapbox](https://www.mapbox.com/). See [license](https://github.com/mapbox/mapbox-gl-native/blob/master/LICENSE.md) for more details.'
+
+head: |
+ <link rel='shortcut icon' href='https://www.mapbox.com/img/favicon.ico' type='image/x-icon' />
+
+objc: Yes
+skip_undocumented: Yes
+hide_documentation_coverage: Yes
+umbrella_header: src/Mapbox.h
+framework_root: ../darwin/src
+
+custom_categories:
+ - name: Maps
+ children:
+ - MGLAccountManager
+ - MGLMapCamera
+ - MGLMapDebugMaskOptions
+ - MGLMapView
+ - MGLMapViewDelegate
+ - MGLStyle
+ - MGLStyleDefaultVersion
+ - MGLUserTrackingMode
+ - name: Annotations
+ children:
+ - MGLAnnotation
+ - MGLAnnotationImage
+ - MGLMultiPoint
+ - MGLPointAnnotation
+ - MGLPolygon
+ - MGLPolyline
+ - MGLOverlay
+ - MGLShape
+ - name: Offline Maps
+ children:
+ - MGLOfflineRegion
+ - MGLOfflineStorage
+ - MGLOfflinePack
+ - MGLOfflinePackAdditionCompletionHandler
+ - MGLOfflinePackErrorNotification
+ - MGLOfflinePackErrorUserInfoKey
+ - MGLOfflinePackMaximumCountUserInfoKey
+ - MGLOfflinePackMaximumMapboxTilesReachedNotification
+ - MGLOfflinePackProgress
+ - MGLOfflinePackProgressChangedNotification
+ - MGLOfflinePackProgressUserInfoKey
+ - MGLOfflinePackRemovalCompletionHandler
+ - MGLOfflinePackState
+ - MGLOfflinePackStateUserInfoKey
+ - MGLTilePyramidOfflineRegion
+ - name: Geometry
+ children:
+ - MGLClockDirectionFormatter
+ - MGLCompassDirectionFormatter
+ - MGLCoordinateBounds
+ - MGLCoordinateBoundsEqualToCoordinateBounds
+ - MGLCoordinateBoundsGetCoordinateSpan
+ - MGLCoordinateBoundsIsEmpty
+ - MGLCoordinateBoundsMake
+ - MGLCoordinateBoundsOffset
+ - MGLCoordinateFormatter
+ - MGLCoordinateSpan
+ - MGLCoordinateSpanEqualToCoordinateSpan
+ - MGLCoordinateSpanMake
+ - MGLCoordinateSpanZero
+ - MGLDegreesFromRadians
+ - MGLRadiansFromDegrees
+ - MGLStringFromCoordinateBounds