diff options
author | Justin R. Miller <incanus@users.noreply.github.com> | 2016-09-27 13:53:32 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2016-09-27 13:53:32 -0700 |
commit | a6aa786f35824922aee0d2baad94e4ce9f71e79c (patch) | |
tree | 4ca6fed37ec4d713b82c9f06da5f3d326e92bb0d /platform/darwin/src/MGLStyleLayer.h.ejs | |
parent | 44c7e9d05edbe6fee9e8f98b91380b6c07e57ac7 (diff) | |
download | qtlocation-mapboxgl-a6aa786f35824922aee0d2baad94e4ce9f71e79c.tar.gz |
[ios, macos] flesh out iOS runtime styling docs (#6466)
- fixes #5959: MGLBaseStyleLayer docs
- fixes #5960: MGLSource & subclasses docs
- fixes #6467: concrete layer subclass docs
- move Core Graphics include
- slight code & template cleanups
- add ./documentation to git ignores
Diffstat (limited to 'platform/darwin/src/MGLStyleLayer.h.ejs')
-rw-r--r-- | platform/darwin/src/MGLStyleLayer.h.ejs | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/platform/darwin/src/MGLStyleLayer.h.ejs b/platform/darwin/src/MGLStyleLayer.h.ejs index 64a7e06b5f..054adcb32e 100644 --- a/platform/darwin/src/MGLStyleLayer.h.ejs +++ b/platform/darwin/src/MGLStyleLayer.h.ejs @@ -33,9 +33,24 @@ typedef NS_ENUM(NSUInteger, MGL<%- camelize(type) %>StyleLayer<%- camelize(prope <% } -%> <% } -%> +<% if (type == 'background') { -%> +/** + A map style's background layer is the bottommost layer and is used to style a color + or pattern to show below all other map features. You can query an `MGLMapView` for its + `style` and obtain the background layer using the `-[MGLStyle layerWithIdentifier:]` + method and passing `background` for the identifier. + */ +<% } else { -%> +/** + A <%- type %> layer which allows customization of styling properties at runtime. You may + instantiate a new <%- type %> layer to add to a map style or you may query an + `MGLMapView` for its `style` and obtain existing layers using the + `-[MGLStyle layerWithIdentifier:]` method. + */ +<% } -%> @interface MGL<%- camelize(type) %>StyleLayer : MGLBaseStyleLayer <MGLStyleLayer> - <% if (type == 'background') { -%> + - (instancetype)initWithLayerIdentifier:(NSString *)layerIdentifier; <% } -%> |