Skip to content
This repository was archived by the owner on Aug 8, 2023. It is now read-only.

Commit 641cfcb

Browse files
frederonifrederoni
committed
[ios, macos] #5626 - updated header template, included doc string
1 parent 063ace3 commit 641cfcb

7 files changed

+288
-17
lines changed

‎platform/darwin/src/MGLBackgroundStyleLayer.h

+12-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
// This file is generated. Do not edit.
1+
// This file is generated.
2+
// Edit platform/ios/scripts/generate-style-code.js, then run `make style-code-ios`.
23

34
#import <Mapbox/Mapbox.h>
45

@@ -7,12 +8,21 @@
78

89
@interface MGLBackgroundStyleLayer : MGLStyleLayer
910

10-
// Paint properties
11+
#pragma mark - Accessing the Paint Attributes
1112

13+
/**
14+
The color with which the background will be drawn.
15+
*/
1216
@property (nonatomic) MGLColor *backgroundColor;
1317

18+
/**
19+
Name of image in sprite to use for drawing an image background. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512).
20+
*/
1421
@property (nonatomic) NSString *backgroundPattern;
1522

23+
/**
24+
The opacity at which the background will be drawn.
25+
*/
1626
@property (nonatomic) CGFloat backgroundOpacity;
1727

1828
@end

‎platform/darwin/src/MGLCircleStyleLayer.h

+24-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
// This file is generated. Do not edit.
1+
// This file is generated.
2+
// Edit platform/ios/scripts/generate-style-code.js, then run `make style-code-ios`.
23

34
#import <Mapbox/Mapbox.h>
45

@@ -15,20 +16,41 @@ typedef NS_ENUM(NSUInteger, MGLCircleStyleLayerCirclePitchScale) {
1516

1617
@interface MGLCircleStyleLayer : MGLStyleLayer
1718

18-
// Paint properties
19+
#pragma mark - Accessing the Paint Attributes
1920

21+
/**
22+
Circle radius.
23+
*/
2024
@property (nonatomic) CGFloat circleRadius;
2125

26+
/**
27+
The color of the circle.
28+
*/
2229
@property (nonatomic) MGLColor *circleColor;
2330

31+
/**
32+
Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.
33+
*/
2434
@property (nonatomic) CGFloat circleBlur;
2535

36+
/**
37+
The opacity at which the circle will be drawn.
38+
*/
2639
@property (nonatomic) CGFloat circleOpacity;
2740

41+
/**
42+
The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
43+
*/
2844
@property (nonatomic) NSArray *circleTranslate;
2945

46+
/**
47+
Control whether the translation is relative to the map (north) or viewport (screen)
48+
*/
3049
@property (nonatomic) MGLCircleStyleLayerCircleTranslateAnchor circleTranslateAnchor;
3150

51+
/**
52+
Controls the scaling behavior of the circle when the map is pitched. The value `map` scales circles according to their apparent distance to the camera. The value `viewport` results in no pitch-related scaling.
53+
*/
3254
@property (nonatomic) MGLCircleStyleLayerCirclePitchScale circlePitchScale;
3355

3456
@end

‎platform/darwin/src/MGLFillStyleLayer.h

+24-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
// This file is generated. Do not edit.
1+
// This file is generated.
2+
// Edit platform/ios/scripts/generate-style-code.js, then run `make style-code-ios`.
23

34
#import <Mapbox/Mapbox.h>
45

@@ -11,20 +12,41 @@ typedef NS_ENUM(NSUInteger, MGLFillStyleLayerFillTranslateAnchor) {
1112

1213
@interface MGLFillStyleLayer : MGLStyleLayer
1314

14-
// Paint properties
15+
#pragma mark - Accessing the Paint Attributes
1516

17+
/**
18+
Whether or not the fill should be antialiased.
19+
*/
1620
@property (nonatomic) BOOL fillAntialias;
1721

22+
/**
23+
The opacity of the entire fill layer. In contrast to the fill-color, this value will also affect the 1px stroke around the fill, if the stroke is used.
24+
*/
1825
@property (nonatomic) CGFloat fillOpacity;
1926

27+
/**
28+
The color of the filled part of this layer. This color can be specified as rgba with an alpha component and the color's opacity will not affect the opacity of the 1px stroke, if it is used.
29+
*/
2030
@property (nonatomic) MGLColor *fillColor;
2131

32+
/**
33+
The outline color of the fill. Matches the value of `fill-color` if unspecified.
34+
*/
2235
@property (nonatomic) MGLColor *fillOutlineColor;
2336

37+
/**
38+
The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
39+
*/
2440
@property (nonatomic) NSArray *fillTranslate;
2541

42+
/**
43+
Control whether the translation is relative to the map (north) or viewport (screen)
44+
*/
2645
@property (nonatomic) MGLFillStyleLayerFillTranslateAnchor fillTranslateAnchor;
2746

47+
/**
48+
Name of image in sprite to use for drawing image fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512).
49+
*/
2850
@property (nonatomic) NSString *fillPattern;
2951

3052
@end

‎platform/darwin/src/MGLLineStyleLayer.h

+46-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
// This file is generated. Do not edit.
1+
// This file is generated.
2+
// Edit platform/ios/scripts/generate-style-code.js, then run `make style-code-ios`.
23

34
#import <Mapbox/Mapbox.h>
45

@@ -21,36 +22,78 @@ typedef NS_ENUM(NSUInteger, MGLLineStyleLayerLineTranslateAnchor) {
2122

2223
@interface MGLLineStyleLayer : MGLStyleLayer
2324

24-
// Layout properties
25+
#pragma mark - Accessing the Layout Attributes
2526

27+
/**
28+
The display of line endings.
29+
*/
2630
@property (nonatomic) MGLLineStyleLayerLineCap lineCap;
2731

32+
/**
33+
The display of lines when joining.
34+
*/
2835
@property (nonatomic) MGLLineStyleLayerLineJoin lineJoin;
2936

37+
/**
38+
Used to automatically convert miter joins to bevel joins for sharp angles.
39+
*/
3040
@property (nonatomic) CGFloat lineMiterLimit;
3141

42+
/**
43+
Used to automatically convert round joins to miter joins for shallow angles.
44+
*/
3245
@property (nonatomic) CGFloat lineRoundLimit;
3346

34-
// Paint properties
47+
#pragma mark - Accessing the Paint Attributes
3548

49+
/**
50+
The opacity at which the line will be drawn.
51+
*/
3652
@property (nonatomic) CGFloat lineOpacity;
3753

54+
/**
55+
The color with which the line will be drawn.
56+
*/
3857
@property (nonatomic) MGLColor *lineColor;
3958

59+
/**
60+
The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.
61+
*/
4062
@property (nonatomic) NSArray *lineTranslate;
4163

64+
/**
65+
Control whether the translation is relative to the map (north) or viewport (screen)
66+
*/
4267
@property (nonatomic) MGLLineStyleLayerLineTranslateAnchor lineTranslateAnchor;
4368

69+
/**
70+
Stroke thickness.
71+
*/
4472
@property (nonatomic) CGFloat lineWidth;
4573

74+
/**
75+
Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap.
76+
*/
4677
@property (nonatomic) CGFloat lineGapWidth;
4778

79+
/**
80+
The line's offset perpendicular to its direction. Values may be positive or negative, where positive indicates "rightwards" (if you were moving in the direction of the line) and negative indicates "leftwards."
81+
*/
4882
@property (nonatomic) CGFloat lineOffset;
4983

84+
/**
85+
Blur applied to the line, in pixels.
86+
*/
5087
@property (nonatomic) CGFloat lineBlur;
5188

89+
/**
90+
Specifies the lengths of the alternating dashes and gaps that form the dash pattern. The lengths are later scaled by the line width. To convert a dash length to pixels, multiply the length by the current line width.
91+
*/
5292
@property (nonatomic) NSArray *lineDasharray;
5393

94+
/**
95+
Name of image in sprite to use for drawing image lines. For seamless patterns, image width must be a factor of two (2, 4, 8, ..., 512).
96+
*/
5497
@property (nonatomic) NSString *linePattern;
5598

5699
@end

‎platform/darwin/src/MGLRasterStyleLayer.h

+24-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
// This file is generated. Do not edit.
1+
// This file is generated.
2+
// Edit platform/ios/scripts/generate-style-code.js, then run `make style-code-ios`.
23

34
#import <Mapbox/Mapbox.h>
45

@@ -7,20 +8,41 @@
78

89
@interface MGLRasterStyleLayer : MGLStyleLayer
910

10-
// Paint properties
11+
#pragma mark - Accessing the Paint Attributes
1112

13+
/**
14+
The opacity at which the image will be drawn.
15+
*/
1216
@property (nonatomic) CGFloat rasterOpacity;
1317

18+
/**
19+
Rotates hues around the color wheel.
20+
*/
1421
@property (nonatomic) CGFloat rasterHueRotate;
1522

23+
/**
24+
Increase or reduce the brightness of the image. The value is the minimum brightness.
25+
*/
1626
@property (nonatomic) CGFloat rasterBrightnessMin;
1727

28+
/**
29+
Increase or reduce the brightness of the image. The value is the maximum brightness.
30+
*/
1831
@property (nonatomic) CGFloat rasterBrightnessMax;
1932

33+
/**
34+
Increase or reduce the saturation of the image.
35+
*/
2036
@property (nonatomic) CGFloat rasterSaturation;
2137

38+
/**
39+
Increase or reduce the contrast of the image.
40+
*/
2241
@property (nonatomic) CGFloat rasterContrast;
2342

43+
/**
44+
Fade duration when a new tile is added.
45+
*/
2446
@property (nonatomic) CGFloat rasterFadeDuration;
2547

2648
@end

‎platform/darwin/src/MGLStyleLayer.h.ejs

+10-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
const layoutProperties = locals.layoutProperties;
44
const paintProperties = locals.paintProperties;
55
-%>
6-
// This file is generated. Do not edit.
6+
// This file is generated.
7+
// Edit platform/ios/scripts/generate-style-code.js, then run `make style-code-ios`.
78

89
#import <Mapbox/Mapbox.h>
910

@@ -31,16 +32,22 @@ typedef NS_ENUM(NSUInteger, MGL<%- camelize(type) %>StyleLayer<%- camelize(prope
3132
@interface MGL<%- camelize(type) %>StyleLayer : MGLStyleLayer
3233

3334
<% if (layoutProperties.length) { -%>
34-
// Layout properties
35+
#pragma mark - Accessing the Layout Attributes
3536
3637
<% for (const property of layoutProperties) { -%>
38+
/**
39+
<%- property.doc %>
40+
*/
3741
@property (nonatomic) <%- propertyType(property, type) %> <% if (isObject(property)) { -%>*<% } -%><%- camelizeWithLeadingLowercase(property.name) %>;
3842
3943
<% } -%>
4044
<% } -%>
41-
// Paint properties
45+
#pragma mark - Accessing the Paint Attributes
4246

4347
<% for (const property of paintProperties) { -%>
48+
/**
49+
<%- property.doc %>
50+
*/
4451
@property (nonatomic) <%- propertyType(property, type) %> <% if (isObject(property)) { -%>*<% } -%><%- camelizeWithLeadingLowercase(property.name) %>;
4552
4653
<% } -%>

0 commit comments

Comments
 (0)