summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMinh Nguyễn <mxn@1ec5.org>2016-10-05 03:33:19 -0700
committerMinh Nguyễn <mxn@1ec5.org>2016-10-11 15:30:16 -0700
commit3c22b14479e200b0339131b033471d59dc7dda9a (patch)
treecca36d5ca18b299d70110394594658ed9902db30
parentc78b5b1d7e95f139ad667781bec0d67b5976809d (diff)
downloadqtlocation-mapboxgl-3c22b14479e200b0339131b033471d59dc7dda9a.tar.gz
[ios, macos] Refer to style layer class in enum documentation
-rw-r--r--platform/darwin/src/MGLCircleStyleLayer.h4
-rw-r--r--platform/darwin/src/MGLFillStyleLayer.h2
-rw-r--r--platform/darwin/src/MGLLineStyleLayer.h6
-rw-r--r--platform/darwin/src/MGLStyleLayer.h.ejs4
-rw-r--r--platform/darwin/src/MGLSymbolStyleLayer.h20
5 files changed, 36 insertions, 0 deletions
diff --git a/platform/darwin/src/MGLCircleStyleLayer.h b/platform/darwin/src/MGLCircleStyleLayer.h
index d15fce7cbe..9a45f7280c 100644
--- a/platform/darwin/src/MGLCircleStyleLayer.h
+++ b/platform/darwin/src/MGLCircleStyleLayer.h
@@ -8,6 +8,8 @@ NS_ASSUME_NONNULL_BEGIN
/**
Controls the translation reference point.
+
+ Values of this type are used in the `circleTranslateAnchor` property of `MGLCircleStyleLayer`.
*/
typedef NS_ENUM(NSUInteger, MGLCircleTranslateAnchor) {
/**
@@ -22,6 +24,8 @@ typedef NS_ENUM(NSUInteger, MGLCircleTranslateAnchor) {
/**
Controls the scaling behavior of the circle when the map is pitched.
+
+ Values of this type are used in the `circlePitchScale` property of `MGLCircleStyleLayer`.
*/
typedef NS_ENUM(NSUInteger, MGLCirclePitchScale) {
/**
diff --git a/platform/darwin/src/MGLFillStyleLayer.h b/platform/darwin/src/MGLFillStyleLayer.h
index 7ce4036cc9..d9ce1abace 100644
--- a/platform/darwin/src/MGLFillStyleLayer.h
+++ b/platform/darwin/src/MGLFillStyleLayer.h
@@ -8,6 +8,8 @@ NS_ASSUME_NONNULL_BEGIN
/**
Controls the translation reference point.
+
+ Values of this type are used in the `fillTranslateAnchor` property of `MGLFillStyleLayer`.
*/
typedef NS_ENUM(NSUInteger, MGLFillTranslateAnchor) {
/**
diff --git a/platform/darwin/src/MGLLineStyleLayer.h b/platform/darwin/src/MGLLineStyleLayer.h
index c00cf112f1..5fb9693e78 100644
--- a/platform/darwin/src/MGLLineStyleLayer.h
+++ b/platform/darwin/src/MGLLineStyleLayer.h
@@ -8,6 +8,8 @@ NS_ASSUME_NONNULL_BEGIN
/**
The display of line endings.
+
+ Values of this type are used in the `lineCap` property of `MGLLineStyleLayer`.
*/
typedef NS_ENUM(NSUInteger, MGLLineCap) {
/**
@@ -26,6 +28,8 @@ typedef NS_ENUM(NSUInteger, MGLLineCap) {
/**
The display of lines when joining.
+
+ Values of this type are used in the `lineJoin` property of `MGLLineStyleLayer`.
*/
typedef NS_ENUM(NSUInteger, MGLLineJoin) {
/**
@@ -44,6 +48,8 @@ typedef NS_ENUM(NSUInteger, MGLLineJoin) {
/**
Controls the translation reference point.
+
+ Values of this type are used in the `lineTranslateAnchor` property of `MGLLineStyleLayer`.
*/
typedef NS_ENUM(NSUInteger, MGLLineTranslateAnchor) {
/**
diff --git a/platform/darwin/src/MGLStyleLayer.h.ejs b/platform/darwin/src/MGLStyleLayer.h.ejs
index 2fc8b1b82a..eb799f13be 100644
--- a/platform/darwin/src/MGLStyleLayer.h.ejs
+++ b/platform/darwin/src/MGLStyleLayer.h.ejs
@@ -21,6 +21,8 @@ NS_ASSUME_NONNULL_BEGIN
<% if (property.type == "enum") { -%>
/**
<%- propertyDoc(property.name, property, type) %>
+
+ Values of this type are used in the `<%- camelizeWithLeadingLowercase(property.name) %>` property of `MGL<%- camelize(type) %>StyleLayer`.
*/
typedef NS_ENUM(NSUInteger, MGL<%- camelize(property.name) %>) {
<% for (const value in property.values) { -%>
@@ -37,6 +39,8 @@ typedef NS_ENUM(NSUInteger, MGL<%- camelize(property.name) %>) {
<% if (property.type == "enum") { -%>
/**
<%- propertyDoc(property.name, property, type) %>
+
+ Values of this type are used in the `<%- camelizeWithLeadingLowercase(property.name) %>` property of `MGL<%- camelize(type) %>StyleLayer`.
*/
typedef NS_ENUM(NSUInteger, MGL<%- camelize(property.name) %>) {
<% for (const value in property.values) { -%>
diff --git a/platform/darwin/src/MGLSymbolStyleLayer.h b/platform/darwin/src/MGLSymbolStyleLayer.h
index db9f1c749b..f8a130d54e 100644
--- a/platform/darwin/src/MGLSymbolStyleLayer.h
+++ b/platform/darwin/src/MGLSymbolStyleLayer.h
@@ -8,6 +8,8 @@ NS_ASSUME_NONNULL_BEGIN
/**
Label placement relative to its geometry.
+
+ Values of this type are used in the `symbolPlacement` property of `MGLSymbolStyleLayer`.
*/
typedef NS_ENUM(NSUInteger, MGLSymbolPlacement) {
/**
@@ -22,6 +24,8 @@ typedef NS_ENUM(NSUInteger, MGLSymbolPlacement) {
/**
In combination with `symbolPlacement`, determines the rotation behavior of icons.
+
+ Values of this type are used in the `iconRotationAlignment` property of `MGLSymbolStyleLayer`.
*/
typedef NS_ENUM(NSUInteger, MGLIconRotationAlignment) {
/**
@@ -40,6 +44,8 @@ typedef NS_ENUM(NSUInteger, MGLIconRotationAlignment) {
/**
Scales the icon to fit around the associated text.
+
+ Values of this type are used in the `iconTextFit` property of `MGLSymbolStyleLayer`.
*/
typedef NS_ENUM(NSUInteger, MGLIconTextFit) {
/**
@@ -62,6 +68,8 @@ typedef NS_ENUM(NSUInteger, MGLIconTextFit) {
/**
Orientation of text when map is pitched.
+
+ Values of this type are used in the `textPitchAlignment` property of `MGLSymbolStyleLayer`.
*/
typedef NS_ENUM(NSUInteger, MGLTextPitchAlignment) {
/**
@@ -80,6 +88,8 @@ typedef NS_ENUM(NSUInteger, MGLTextPitchAlignment) {
/**
In combination with `symbolPlacement`, determines the rotation behavior of the individual glyphs forming the text.
+
+ Values of this type are used in the `textRotationAlignment` property of `MGLSymbolStyleLayer`.
*/
typedef NS_ENUM(NSUInteger, MGLTextRotationAlignment) {
/**
@@ -98,6 +108,8 @@ typedef NS_ENUM(NSUInteger, MGLTextRotationAlignment) {
/**
Text justification options.
+
+ Values of this type are used in the `textJustify` property of `MGLSymbolStyleLayer`.
*/
typedef NS_ENUM(NSUInteger, MGLTextJustify) {
/**
@@ -116,6 +128,8 @@ typedef NS_ENUM(NSUInteger, MGLTextJustify) {
/**
Part of the text placed closest to the anchor.
+
+ Values of this type are used in the `textAnchor` property of `MGLSymbolStyleLayer`.
*/
typedef NS_ENUM(NSUInteger, MGLTextAnchor) {
/**
@@ -158,6 +172,8 @@ typedef NS_ENUM(NSUInteger, MGLTextAnchor) {
/**
Specifies how to capitalize text, similar to the CSS `text-transform` property.
+
+ Values of this type are used in the `textTransform` property of `MGLSymbolStyleLayer`.
*/
typedef NS_ENUM(NSUInteger, MGLTextTransform) {
/**
@@ -176,6 +192,8 @@ typedef NS_ENUM(NSUInteger, MGLTextTransform) {
/**
Controls the translation reference point.
+
+ Values of this type are used in the `iconTranslateAnchor` property of `MGLSymbolStyleLayer`.
*/
typedef NS_ENUM(NSUInteger, MGLIconTranslateAnchor) {
/**
@@ -190,6 +208,8 @@ typedef NS_ENUM(NSUInteger, MGLIconTranslateAnchor) {
/**
Controls the translation reference point.
+
+ Values of this type are used in the `textTranslateAnchor` property of `MGLSymbolStyleLayer`.
*/
typedef NS_ENUM(NSUInteger, MGLTextTranslateAnchor) {
/**