diff options
author | Eric Wolfe <eric.r.wolfe@gmail.com> | 2016-12-21 10:22:13 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2016-12-21 10:22:13 -0800 |
commit | 9faa4af1c3cf0665ede20de8d98005ef9016b792 (patch) | |
tree | 39f2b2ab956798038271bf4a2507c5d6d6d1b9ea /platform/darwin | |
parent | b27dabfe472b633922c8beb615a80201ef5b8635 (diff) | |
download | qtlocation-mapboxgl-9faa4af1c3cf0665ede20de8d98005ef9016b792.tar.gz |
[ios] Add inline examples in documentation (#7337)
Diffstat (limited to 'platform/darwin')
-rw-r--r-- | platform/darwin/src/MGLCircleStyleLayer.h | 2 | ||||
-rw-r--r-- | platform/darwin/src/MGLFillStyleLayer.h | 2 | ||||
-rw-r--r-- | platform/darwin/src/MGLLineStyleLayer.h | 2 | ||||
-rw-r--r-- | platform/darwin/src/MGLRasterSource.h | 3 | ||||
-rw-r--r-- | platform/darwin/src/MGLRasterStyleLayer.h | 2 | ||||
-rw-r--r-- | platform/darwin/src/MGLShapeSource.h | 3 | ||||
-rw-r--r-- | platform/darwin/src/MGLSource.h | 2 | ||||
-rw-r--r-- | platform/darwin/src/MGLStyleLayer.h.ejs | 2 | ||||
-rw-r--r-- | platform/darwin/src/MGLSymbolStyleLayer.h | 2 | ||||
-rw-r--r-- | platform/darwin/src/MGLVectorSource.h | 2 | ||||
-rw-r--r-- | platform/darwin/src/MGLVectorStyleLayer.h | 2 |
11 files changed, 23 insertions, 1 deletions
diff --git a/platform/darwin/src/MGLCircleStyleLayer.h b/platform/darwin/src/MGLCircleStyleLayer.h index ddea62e5be..b57e245da2 100644 --- a/platform/darwin/src/MGLCircleStyleLayer.h +++ b/platform/darwin/src/MGLCircleStyleLayer.h @@ -59,6 +59,8 @@ typedef NS_ENUM(NSUInteger, MGLCircleTranslateAnchor) { otherwise, find it using the `MGLStyle.layers` property. You can also create a new circle style layer and add it to the style using a method such as `-[MGLStyle addLayer:]`. + + <!--EXAMPLE: MGLCircleStyleLayer--> */ @interface MGLCircleStyleLayer : MGLVectorStyleLayer diff --git a/platform/darwin/src/MGLFillStyleLayer.h b/platform/darwin/src/MGLFillStyleLayer.h index 01f1b17f97..2638e85aa5 100644 --- a/platform/darwin/src/MGLFillStyleLayer.h +++ b/platform/darwin/src/MGLFillStyleLayer.h @@ -37,6 +37,8 @@ typedef NS_ENUM(NSUInteger, MGLFillTranslateAnchor) { otherwise, find it using the `MGLStyle.layers` property. You can also create a new fill style layer and add it to the style using a method such as `-[MGLStyle addLayer:]`. + + <!--EXAMPLE: MGLFillStyleLayer--> */ @interface MGLFillStyleLayer : MGLVectorStyleLayer diff --git a/platform/darwin/src/MGLLineStyleLayer.h b/platform/darwin/src/MGLLineStyleLayer.h index c0f2eb322b..c3371aa2a7 100644 --- a/platform/darwin/src/MGLLineStyleLayer.h +++ b/platform/darwin/src/MGLLineStyleLayer.h @@ -87,6 +87,8 @@ typedef NS_ENUM(NSUInteger, MGLLineTranslateAnchor) { otherwise, find it using the `MGLStyle.layers` property. You can also create a new line style layer and add it to the style using a method such as `-[MGLStyle addLayer:]`. + + <!--EXAMPLE: MGLLineStyleLayer--> */ @interface MGLLineStyleLayer : MGLVectorStyleLayer diff --git a/platform/darwin/src/MGLRasterSource.h b/platform/darwin/src/MGLRasterSource.h index 262e8f2ce1..3efd84f383 100644 --- a/platform/darwin/src/MGLRasterSource.h +++ b/platform/darwin/src/MGLRasterSource.h @@ -35,6 +35,9 @@ extern const MGLTileSourceOption MGLTileSourceOptionTileSize; `MGLRasterSource` object that you can use to initialize new style layers. You can also add and remove sources dynamically using methods such as `-[MGLStyle addSource:]` and `-[MGLStyle sourceWithIdentifier:]`. + + <!--EXAMPLE: MGLRasterSource--> + ``` */ @interface MGLRasterSource : MGLTileSource diff --git a/platform/darwin/src/MGLRasterStyleLayer.h b/platform/darwin/src/MGLRasterStyleLayer.h index 52b2f8aff6..7b53eebf96 100644 --- a/platform/darwin/src/MGLRasterStyleLayer.h +++ b/platform/darwin/src/MGLRasterStyleLayer.h @@ -23,6 +23,8 @@ NS_ASSUME_NONNULL_BEGIN otherwise, find it using the `MGLStyle.layers` property. You can also create a new raster style layer and add it to the style using a method such as `-[MGLStyle addLayer:]`. + + <!--EXAMPLE: MGLRasterStyleLayer--> */ @interface MGLRasterStyleLayer : MGLForegroundStyleLayer diff --git a/platform/darwin/src/MGLShapeSource.h b/platform/darwin/src/MGLShapeSource.h index 68cb40a83f..0eb454437b 100644 --- a/platform/darwin/src/MGLShapeSource.h +++ b/platform/darwin/src/MGLShapeSource.h @@ -74,6 +74,9 @@ extern const MGLShapeSourceOption MGLShapeSourceOptionSimplificationTolerance; Any vector style layer initialized with a shape source should have a `nil` value in its `sourceLayerIdentifier` property. + + <!--EXAMPLE: MGLShapeSource--> + ``` */ @interface MGLShapeSource : MGLSource diff --git a/platform/darwin/src/MGLSource.h b/platform/darwin/src/MGLSource.h index 6b381fca19..03bb5fcba2 100644 --- a/platform/darwin/src/MGLSource.h +++ b/platform/darwin/src/MGLSource.h @@ -16,7 +16,7 @@ NS_ASSUME_NONNULL_BEGIN Do not create instances of this class directly, and do not create your own subclasses of this class. Instead, create instances of `MGLShapeSource` and the - concrete subclasses of `MGLTileSource`. + concrete subclasses of `MGLTileSource`, `MGLVectorSource` and `MGLRasterSource`. */ @interface MGLSource : NSObject diff --git a/platform/darwin/src/MGLStyleLayer.h.ejs b/platform/darwin/src/MGLStyleLayer.h.ejs index 2754cca1c5..ac95022ea7 100644 --- a/platform/darwin/src/MGLStyleLayer.h.ejs +++ b/platform/darwin/src/MGLStyleLayer.h.ejs @@ -67,6 +67,8 @@ typedef NS_ENUM(NSUInteger, MGL<%- camelize(property.name) %>) { otherwise, find it using the `MGLStyle.layers` property. You can also create a new <%- type %> style layer and add it to the style using a method such as `-[MGLStyle addLayer:]`. + + <!--EXAMPLE: MGL<%- camelize(type) %>StyleLayer--> */ <% } -%> @interface MGL<%- camelize(type) %>StyleLayer : MGL<%- diff --git a/platform/darwin/src/MGLSymbolStyleLayer.h b/platform/darwin/src/MGLSymbolStyleLayer.h index a7b47ad2bb..052d67617a 100644 --- a/platform/darwin/src/MGLSymbolStyleLayer.h +++ b/platform/darwin/src/MGLSymbolStyleLayer.h @@ -260,6 +260,8 @@ typedef NS_ENUM(NSUInteger, MGLTextTranslateAnchor) { otherwise, find it using the `MGLStyle.layers` property. You can also create a new symbol style layer and add it to the style using a method such as `-[MGLStyle addLayer:]`. + + <!--EXAMPLE: MGLSymbolStyleLayer--> */ @interface MGLSymbolStyleLayer : MGLVectorStyleLayer diff --git a/platform/darwin/src/MGLVectorSource.h b/platform/darwin/src/MGLVectorSource.h index f91a0cbb23..ba8f075b5a 100644 --- a/platform/darwin/src/MGLVectorSource.h +++ b/platform/darwin/src/MGLVectorSource.h @@ -24,6 +24,8 @@ NS_ASSUME_NONNULL_BEGIN (<var>extent</var> × 2) − 1, inclusive. Any vector style layer initialized with a vector source must have a non-`nil` value in its `sourceLayerIdentifier` property. + + <!--EXAMPLE: MGLVectorSource--> */ @interface MGLVectorSource : MGLTileSource diff --git a/platform/darwin/src/MGLVectorStyleLayer.h b/platform/darwin/src/MGLVectorStyleLayer.h index 1197d76807..ff07a71a76 100644 --- a/platform/darwin/src/MGLVectorStyleLayer.h +++ b/platform/darwin/src/MGLVectorStyleLayer.h @@ -128,6 +128,8 @@ NS_ASSUME_NONNULL_BEGIN style attributes and also `hyphen-minus` and `tag:subtag`. However, you must use `%K` in the format string to represent these variables: `@"%K == 'LineString'", @"$type"`. + + <!--EXAMPLE: MGLVectorStyleLayer.predicate--> */ @property (nonatomic, nullable) NSPredicate *predicate; |