Skip to content

Commit 2a4bedd

Browse files
tobruntobrun
committed
[annotation] - add javadoc on updating annotations through their managers
1 parent d003da0 commit 2a4bedd

5 files changed

Lines changed: 163 additions & 8 deletions

File tree

‎plugin-annotation/scripts/annotation.java.ejs‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ public class <%- camelize(type) %> extends Annotation {
4040
4141
/**
4242
* Set the LatLng of the <%- type %>, which represents the location of the <%- type %> on the map
43+
* <p>
44+
* To update the <%- type %> on the map use {@link <%- camelize(type) %>Manager#update(Annotation)}.
45+
* <p>
4346
*
4447
* @param latLng the location of the <%- type %> in a longitude and latitude pair
4548
*/
@@ -50,6 +53,9 @@ public class <%- camelize(type) %> extends Annotation {
5053
5154
/**
5255
* Set a list of LatLng for the line, which represents the locations of the line on the map
56+
* <p>
57+
* To update the <%- type %> on the map use {@link <%- camelize(type) %>Manager#update(Annotation)}.
58+
* <p>
5359
*
5460
* @param latLngs a list of the locations of the line in a longitude and latitude pairs
5561
*/
@@ -64,6 +70,9 @@ public class <%- camelize(type) %> extends Annotation {
6470
6571
/**
6672
* Set a list of lists of LatLng for the fill, which represents the locations of the fill on the map
73+
* <p>
74+
* To update the <%- type %> on the map use {@link <%- camelize(type) %>Manager#update(Annotation)}.
75+
* <p>
6776
*
6877
* @param latLngs a list of a lists of the locations of the line in a longitude and latitude pairs
6978
*/
@@ -126,8 +135,10 @@ public class <%- camelize(type) %> extends Annotation {
126135
}
127136
128137
/**
129-
* Set the <%- camelize(property.name) %> property
130-
*
138+
* Set the <%- camelize(property.name) %> property.
139+
* <p>
140+
* To update the <%- type %> on the map use {@link <%- camelize(type) %>Manager#update(Annotation)}.
141+
* <p>
131142
* @param value constant property value for <%- propertyType(property) %>
132143
*/
133144
public void set<%- camelize(property.name) %>(<%- propertyTypeAnnotation(property) %><%- iff(() => propertyTypeAnnotation(property), " ") %><%- propertyType(property) %> value) {
@@ -150,6 +161,9 @@ public class <%- camelize(type) %> extends Annotation {
150161
151162
/**
152163
* Set the <%- camelize(property.name) %> property
164+
* <p>
165+
* To update the <%- type %> on the map use {@link <%- camelize(type) %>Manager#update(Annotation)}.
166+
* <p>
153167
*
154168
* @param value constant property value for <%- propertyType(property) %>
155169
*/

‎plugin-annotation/src/main/java/com/mapbox/mapboxsdk/plugins/annotation/Circle.java‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ public class Circle extends Annotation {
2828

2929
/**
3030
* Set the LatLng of the circle, which represents the location of the circle on the map
31+
* <p>
32+
* To update the circle on the map use {@link CircleManager#update(Annotation)}.
33+
* <p>
3134
*
3235
* @param latLng the location of the circle in a longitude and latitude pair
3336
*/
@@ -47,6 +50,9 @@ public Float getCircleRadius() {
4750

4851
/**
4952
* Set the CircleRadius property
53+
* <p>
54+
* To update the circle on the map use {@link CircleManager#update(Annotation)}.
55+
* <p>
5056
*
5157
* @param value constant property value for Float
5258
*/
@@ -65,6 +71,9 @@ public String getCircleColor() {
6571

6672
/**
6773
* Set the CircleColor property
74+
* <p>
75+
* To update the circle on the map use {@link CircleManager#update(Annotation)}.
76+
* <p>
6877
*
6978
* @param value constant property value for String
7079
*/
@@ -83,6 +92,9 @@ public Float getCircleBlur() {
8392

8493
/**
8594
* Set the CircleBlur property
95+
* <p>
96+
* To update the circle on the map use {@link CircleManager#update(Annotation)}.
97+
* <p>
8698
*
8799
* @param value constant property value for Float
88100
*/
@@ -101,6 +113,9 @@ public Float getCircleOpacity() {
101113

102114
/**
103115
* Set the CircleOpacity property
116+
* <p>
117+
* To update the circle on the map use {@link CircleManager#update(Annotation)}.
118+
* <p>
104119
*
105120
* @param value constant property value for Float
106121
*/
@@ -119,6 +134,9 @@ public Float getCircleStrokeWidth() {
119134

120135
/**
121136
* Set the CircleStrokeWidth property
137+
* <p>
138+
* To update the circle on the map use {@link CircleManager#update(Annotation)}.
139+
* <p>
122140
*
123141
* @param value constant property value for Float
124142
*/
@@ -137,6 +155,9 @@ public String getCircleStrokeColor() {
137155

138156
/**
139157
* Set the CircleStrokeColor property
158+
* <p>
159+
* To update the circle on the map use {@link CircleManager#update(Annotation)}.
160+
* <p>
140161
*
141162
* @param value constant property value for String
142163
*/
@@ -155,6 +176,9 @@ public Float getCircleStrokeOpacity() {
155176

156177
/**
157178
* Set the CircleStrokeOpacity property
179+
* <p>
180+
* To update the circle on the map use {@link CircleManager#update(Annotation)}.
181+
* <p>
158182
*
159183
* @param value constant property value for Float
160184
*/

‎plugin-annotation/src/main/java/com/mapbox/mapboxsdk/plugins/annotation/Fill.java‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ public class Fill extends Annotation {
2828

2929
/**
3030
* Set a list of lists of LatLng for the fill, which represents the locations of the fill on the map
31+
* <p>
32+
* To update the fill on the map use {@link FillManager#update(Annotation)}.
33+
* <p>
3134
*
3235
* @param latLngs a list of a lists of the locations of the line in a longitude and latitude pairs
3336
*/
@@ -55,6 +58,9 @@ public Float getFillOpacity() {
5558

5659
/**
5760
* Set the FillOpacity property
61+
* <p>
62+
* To update the fill on the map use {@link FillManager#update(Annotation)}.
63+
* <p>
5864
*
5965
* @param value constant property value for Float
6066
*/
@@ -73,6 +79,9 @@ public String getFillColor() {
7379

7480
/**
7581
* Set the FillColor property
82+
* <p>
83+
* To update the fill on the map use {@link FillManager#update(Annotation)}.
84+
* <p>
7685
*
7786
* @param value constant property value for String
7887
*/
@@ -91,6 +100,9 @@ public String getFillOutlineColor() {
91100

92101
/**
93102
* Set the FillOutlineColor property
103+
* <p>
104+
* To update the fill on the map use {@link FillManager#update(Annotation)}.
105+
* <p>
94106
*
95107
* @param value constant property value for String
96108
*/
@@ -109,6 +121,9 @@ public String getFillPattern() {
109121

110122
/**
111123
* Set the FillPattern property
124+
* <p>
125+
* To update the fill on the map use {@link FillManager#update(Annotation)}.
126+
* <p>
112127
*
113128
* @param value constant property value for String
114129
*/

‎plugin-annotation/src/main/java/com/mapbox/mapboxsdk/plugins/annotation/Line.java‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ public class Line extends Annotation {
2828

2929
/**
3030
* Set a list of LatLng for the line, which represents the locations of the line on the map
31+
* <p>
32+
* To update the line on the map use {@link LineManager#update(Annotation)}.
33+
* <p>
3134
*
3235
* @param latLngs a list of the locations of the line in a longitude and latitude pairs
3336
*/
@@ -51,6 +54,9 @@ public String getLineJoin() {
5154

5255
/**
5356
* Set the LineJoin property
57+
* <p>
58+
* To update the line on the map use {@link LineManager#update(Annotation)}.
59+
* <p>
5460
*
5561
* @param value constant property value for String
5662
*/
@@ -69,6 +75,9 @@ public Float getLineOpacity() {
6975

7076
/**
7177
* Set the LineOpacity property
78+
* <p>
79+
* To update the line on the map use {@link LineManager#update(Annotation)}.
80+
* <p>
7281
*
7382
* @param value constant property value for Float
7483
*/
@@ -87,6 +96,9 @@ public String getLineColor() {
8796

8897
/**
8998
* Set the LineColor property
99+
* <p>
100+
* To update the line on the map use {@link LineManager#update(Annotation)}.
101+
* <p>
90102
*
91103
* @param value constant property value for String
92104
*/
@@ -105,6 +117,9 @@ public Float getLineWidth() {
105117

106118
/**
107119
* Set the LineWidth property
120+
* <p>
121+
* To update the line on the map use {@link LineManager#update(Annotation)}.
122+
* <p>
108123
*
109124
* @param value constant property value for Float
110125
*/
@@ -123,6 +138,9 @@ public Float getLineGapWidth() {
123138

124139
/**
125140
* Set the LineGapWidth property
141+
* <p>
142+
* To update the line on the map use {@link LineManager#update(Annotation)}.
143+
* <p>
126144
*
127145
* @param value constant property value for Float
128146
*/
@@ -141,6 +159,9 @@ public Float getLineOffset() {
141159

142160
/**
143161
* Set the LineOffset property
162+
* <p>
163+
* To update the line on the map use {@link LineManager#update(Annotation)}.
164+
* <p>
144165
*
145166
* @param value constant property value for Float
146167
*/
@@ -159,6 +180,9 @@ public Float getLineBlur() {
159180

160181
/**
161182
* Set the LineBlur property
183+
* <p>
184+
* To update the line on the map use {@link LineManager#update(Annotation)}.
185+
* <p>
162186
*
163187
* @param value constant property value for Float
164188
*/
@@ -177,6 +201,9 @@ public String getLinePattern() {
177201

178202
/**
179203
* Set the LinePattern property
204+
* <p>
205+
* To update the line on the map use {@link LineManager#update(Annotation)}.
206+
* <p>
180207
*
181208
* @param value constant property value for String
182209
*/

0 commit comments

Comments
 (0)