Skip to content

Commit e78e7bc

Browse files
Document maps SDK cap
1 parent 5960b31 commit e78e7bc

File tree

3 files changed

+26
-9
lines changed

3 files changed

+26
-9
lines changed

packages/google_maps_flutter/google_maps_flutter_android/android/src/main/java/io/flutter/plugins/googlemaps/Messages.java

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,11 @@ private PlatformJointType(final int index) {
113113
}
114114
}
115115

116-
/** Enumeration of possible types of Cap. */
116+
/**
117+
* Enumeration of possible types of PlatformCap, corresponding to the subclasses of Cap in the
118+
* Google Maps Android SDK. See
119+
* https://developers.google.com/maps/documentation/android-sdk/reference/com/google/android/libraries/maps/model/Cap.
120+
*/
117121
public enum PlatformCapType {
118122
BUTT_CAP(0),
119123
ROUND_CAP(1),
@@ -1832,7 +1836,10 @@ public void setPoints(@NonNull List<PlatformLatLng> setterArg) {
18321836
this.points = setterArg;
18331837
}
18341838

1835-
/** The start and end cap data. */
1839+
/**
1840+
* The cap at the start and end vertex of a polyline. See
1841+
* https://developers.google.com/maps/documentation/android-sdk/reference/com/google/android/libraries/maps/model/Cap.
1842+
*/
18361843
private @NonNull PlatformCap startCap;
18371844

18381845
public @NonNull PlatformCap getStartCap() {
@@ -2111,7 +2118,8 @@ ArrayList<Object> toList() {
21112118
}
21122119

21132120
/**
2114-
* Pigeon equivalent of the Cap class.
2121+
* Pigeon equivalent of Cap from the platform interface.
2122+
* https://github.com/flutter/packages/blob/main/packages/google_maps_flutter/google_maps_flutter_platform_interface/lib/src/types/cap.dart
21152123
*
21162124
* <p>Generated class from Pigeon that represents data sent in messages.
21172125
*/

packages/google_maps_flutter/google_maps_flutter_android/lib/src/messages.g.dart

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,9 @@ enum PlatformJointType {
5050
round,
5151
}
5252

53-
/// Enumeration of possible types of Cap.
53+
/// Enumeration of possible types of PlatformCap, corresponding to the
54+
/// subclasses of Cap in the Google Maps Android SDK.
55+
/// See https://developers.google.com/maps/documentation/android-sdk/reference/com/google/android/libraries/maps/model/Cap.
5456
enum PlatformCapType {
5557
buttCap,
5658
roundCap,
@@ -471,7 +473,8 @@ class PlatformPolyline {
471473

472474
List<PlatformLatLng?> points;
473475

474-
/// The start and end cap data.
476+
/// The cap at the start and end vertex of a polyline.
477+
/// See https://developers.google.com/maps/documentation/android-sdk/reference/com/google/android/libraries/maps/model/Cap.
475478
PlatformCap startCap;
476479

477480
PlatformCap endCap;
@@ -518,7 +521,8 @@ class PlatformPolyline {
518521
}
519522
}
520523

521-
/// Pigeon equivalent of the Cap class.
524+
/// Pigeon equivalent of Cap from the platform interface.
525+
/// https://github.com/flutter/packages/blob/main/packages/google_maps_flutter/google_maps_flutter_platform_interface/lib/src/types/cap.dart
522526
class PlatformCap {
523527
PlatformCap({
524528
required this.type,

packages/google_maps_flutter/google_maps_flutter_android/pigeons/messages.dart

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -218,23 +218,28 @@ class PlatformPolyline {
218218
final List<Object?> patterns;
219219
final List<PlatformLatLng?> points;
220220

221-
/// The start and end cap data.
221+
/// The cap at the start and end vertex of a polyline.
222+
/// See https://developers.google.com/maps/documentation/android-sdk/reference/com/google/android/libraries/maps/model/Cap.
222223
final PlatformCap startCap;
223224
final PlatformCap endCap;
225+
224226
final bool visible;
225227
final int width;
226228
final int zIndex;
227229
}
228230

229-
/// Enumeration of possible types of Cap.
231+
/// Enumeration of possible types of PlatformCap, corresponding to the
232+
/// subclasses of Cap in the Google Maps Android SDK.
233+
/// See https://developers.google.com/maps/documentation/android-sdk/reference/com/google/android/libraries/maps/model/Cap.
230234
enum PlatformCapType {
231235
buttCap,
232236
roundCap,
233237
squareCap,
234238
customCap,
235239
}
236240

237-
/// Pigeon equivalent of the Cap class.
241+
/// Pigeon equivalent of Cap from the platform interface.
242+
/// https://github.com/flutter/packages/blob/main/packages/google_maps_flutter/google_maps_flutter_platform_interface/lib/src/types/cap.dart
238243
class PlatformCap {
239244
PlatformCap({required this.type, this.bitmapDescriptor, this.refWidth});
240245

0 commit comments

Comments
 (0)