diff options
author | Minh Nguyễn <mxn@1ec5.org> | 2016-12-06 11:21:08 -0800 |
---|---|---|
committer | Fredrik Karlsson <bjorn.fredrik.karlsson@gmail.com> | 2016-12-06 22:18:03 +0100 |
commit | e6d51c384d0015f4dfbabb1d3f15d84a0502b9ae (patch) | |
tree | a4c78f8c08aad5c18d0785ea1320b4ba907247fe /platform | |
parent | 903246b25647fe224f6f81684aa6456f45654dbb (diff) | |
download | qtlocation-mapboxgl-e6d51c384d0015f4dfbabb1d3f15d84a0502b9ae.tar.gz |
[ios, macos] Note corresponding style spec properties
Documentation for attributes whose names we’ve overridden now mention the original style specification property name, with a link to the style specification documentation for the property.
Diffstat (limited to 'platform')
-rw-r--r-- | platform/darwin/src/MGLLineStyleLayer.h | 2 | ||||
-rw-r--r-- | platform/darwin/src/MGLRasterStyleLayer.h | 4 | ||||
-rw-r--r-- | platform/darwin/src/MGLStyleLayer.h.ejs | 8 | ||||
-rw-r--r-- | platform/darwin/src/MGLSymbolStyleLayer.h | 4 |
4 files changed, 18 insertions, 0 deletions
diff --git a/platform/darwin/src/MGLLineStyleLayer.h b/platform/darwin/src/MGLLineStyleLayer.h index 95ef760272..fce7555272 100644 --- a/platform/darwin/src/MGLLineStyleLayer.h +++ b/platform/darwin/src/MGLLineStyleLayer.h @@ -141,6 +141,8 @@ typedef NS_ENUM(NSUInteger, MGLLineTranslateAnchor) { This property is measured in line widths. This property is only applied to the style if `linePattern` is set to `nil`. Otherwise, it is ignored. + + This attribute corresponds to the <a href="https://www.mapbox.com/mapbox-gl-style-spec/#paint-line-dasharray"><code>line-dasharray</code></a> paint property in the Mapbox Style Specification. */ @property (nonatomic, null_resettable) MGLStyleValue<NSArray<NSNumber *> *> *lineDashPattern; diff --git a/platform/darwin/src/MGLRasterStyleLayer.h b/platform/darwin/src/MGLRasterStyleLayer.h index 68b187a908..e1b88900b0 100644 --- a/platform/darwin/src/MGLRasterStyleLayer.h +++ b/platform/darwin/src/MGLRasterStyleLayer.h @@ -20,6 +20,8 @@ NS_ASSUME_NONNULL_BEGIN Increase or reduce the brightness of the image. The value is the maximum brightness. The default value of this property is an `MGLStyleValue` object containing an `NSNumber` object containing the float `1`. Set this property to `nil` to reset it to the default value. + + This attribute corresponds to the <a href="https://www.mapbox.com/mapbox-gl-style-spec/#paint-raster-brightness-max"><code>raster-brightness-max</code></a> paint property in the Mapbox Style Specification. */ @property (nonatomic, null_resettable) MGLStyleValue<NSNumber *> *maximumRasterBrightness; @@ -27,6 +29,8 @@ NS_ASSUME_NONNULL_BEGIN Increase or reduce the brightness of the image. The value is the minimum brightness. The default value of this property is an `MGLStyleValue` object containing an `NSNumber` object containing the float `0`. Set this property to `nil` to reset it to the default value. + + This attribute corresponds to the <a href="https://www.mapbox.com/mapbox-gl-style-spec/#paint-raster-brightness-min"><code>raster-brightness-min</code></a> paint property in the Mapbox Style Specification. */ @property (nonatomic, null_resettable) MGLStyleValue<NSNumber *> *minimumRasterBrightness; diff --git a/platform/darwin/src/MGLStyleLayer.h.ejs b/platform/darwin/src/MGLStyleLayer.h.ejs index b97d070b90..d454ec0c6f 100644 --- a/platform/darwin/src/MGLStyleLayer.h.ejs +++ b/platform/darwin/src/MGLStyleLayer.h.ejs @@ -91,6 +91,10 @@ typedef NS_ENUM(NSUInteger, MGL<%- camelize(property.name) %>) { <%- propertyReqs(property, layoutPropertiesByName, type) %> <% } -%> +<% if (property.original) { -%> + + This attribute corresponds to the <a href="https://www.mapbox.com/mapbox-gl-style-spec/#layout-<%- type -%>-<%- property.original -%>"><code><%- property.original -%></code></a> layout property in the Mapbox Style Specification. +<% } -%> */ @property (nonatomic<% if (!property.required) { %>, null_resettable<% } %>) MGLStyleValue<<%- propertyType(property, true) %>> *<%- camelizeWithLeadingLowercase(property.name) %>; @@ -109,6 +113,10 @@ typedef NS_ENUM(NSUInteger, MGL<%- camelize(property.name) %>) { <%- propertyReqs(property, paintPropertiesByName, type) %> <% } -%> +<% if (property.original) { -%> + + This attribute corresponds to the <a href="https://www.mapbox.com/mapbox-gl-style-spec/#paint-<%- property.original -%>"><code><%- property.original -%></code></a> paint property in the Mapbox Style Specification. +<% } -%> */ @property (nonatomic<% if (!property.required) { %>, null_resettable<% } %>) MGLStyleValue<<%- propertyType(property, true) %>> *<%- camelizeWithLeadingLowercase(property.name) %>; diff --git a/platform/darwin/src/MGLSymbolStyleLayer.h b/platform/darwin/src/MGLSymbolStyleLayer.h index 1a97717ad4..d0ec648ba4 100644 --- a/platform/darwin/src/MGLSymbolStyleLayer.h +++ b/platform/darwin/src/MGLSymbolStyleLayer.h @@ -252,6 +252,8 @@ typedef NS_ENUM(NSUInteger, MGLTextTranslateAnchor) { /** A string with {tokens} replaced, referencing the data property to pull from. + + This attribute corresponds to the <a href="https://www.mapbox.com/mapbox-gl-style-spec/#layout-symbol-icon-image"><code>icon-image</code></a> layout property in the Mapbox Style Specification. */ @property (nonatomic, null_resettable) MGLStyleValue<NSString *> *iconImageName; @@ -319,6 +321,8 @@ typedef NS_ENUM(NSUInteger, MGLTextTranslateAnchor) { The default value of this property is an `MGLStyleValue` object containing an `NSNumber` object containing the float `1`. Set this property to `nil` to reset it to the default value. This property is only applied to the style if `iconImage` is non-`nil`. Otherwise, it is ignored. + + This attribute corresponds to the <a href="https://www.mapbox.com/mapbox-gl-style-spec/#layout-symbol-icon-size"><code>icon-size</code></a> layout property in the Mapbox Style Specification. */ @property (nonatomic, null_resettable) MGLStyleValue<NSNumber *> *iconScale; |