Skip to content

Commit cf7866b

Browse files
committed
Fix comments
1 parent 2da7188 commit cf7866b

38 files changed

+115
-134
lines changed

packages/google_maps_flutter/google_maps_flutter/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,10 +124,10 @@ in an unbounded widget will cause the application to throw a Flutter exception.
124124
<?code-excerpt "readme_sample_advanced_markers.dart (AdvancedMarkersSample)"?>
125125
```dart
126126
body: GoogleMap(
127-
// Set your Map Id
127+
// Set your Map ID.
128128
mapId: 'my-map-id',
129129
130-
// Let map know that you're using Advanced Markers
130+
// // Enable support for Advanced Markers.
131131
markerType: MarkerType.advancedMarker,
132132
```
133133

packages/google_maps_flutter/google_maps_flutter/example/lib/advanced_marker_icons.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ import 'main.dart' as main;
99
import 'marker_icons.dart';
1010
import 'page.dart';
1111

12-
/// Page that demonstrates how to use custom [AdvanceMarker] icons
12+
/// Page that demonstrates how to use custom [AdvanceMarker] icons.
1313
class AdvancedMarkerIconsPage extends GoogleMapExampleAppPage {
14-
/// Default constructor
14+
/// Default constructor.
1515
const AdvancedMarkerIconsPage({Key? key})
1616
: super(
1717
key: key,

packages/google_maps_flutter/google_maps_flutter/example/lib/clustering.dart

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ class ClusteringBody extends StatefulWidget {
3030
@override
3131
State<StatefulWidget> createState() => ClusteringBodyState();
3232

33-
/// Create a marker that is later added to a cluster
33+
/// Creates a marker that is later added to a cluster
3434
Marker createMarker({
3535
required MarkerId markerId,
3636
required ClusterManagerId clusterManagerId,
@@ -47,7 +47,7 @@ class ClusteringBody extends StatefulWidget {
4747
);
4848
}
4949

50-
/// Return selected or unselected state of the given [marker]
50+
/// Returns selected or unselected state of the given [marker].
5151
Marker getSelectedMarker(Marker marker, bool isSelected) {
5252
return marker.copyWith(
5353
iconParam: isSelected
@@ -56,7 +56,7 @@ class ClusteringBody extends StatefulWidget {
5656
);
5757
}
5858

59-
/// Return the mapId to use for the GoogleMap
59+
/// Returns the mapId to use for the GoogleMap
6060
String? get mapId => null;
6161
}
6262

packages/google_maps_flutter/google_maps_flutter/example/lib/main.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ import 'scrolling_map.dart';
3232
import 'snapshot.dart';
3333
import 'tile_overlay.dart';
3434

35-
/// Map Id is required for some examples to use advanced markers
35+
/// Map ID is required for some examples to use advanced markers.
3636
// ignore: unnecessary_nullable_for_final_variable_declarations, unreachable_from_main
3737
const String? mapId = null;
3838

packages/google_maps_flutter/google_maps_flutter/example/lib/marker_icons.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ class MarkerIconsBody extends StatefulWidget {
3131
@override
3232
State<StatefulWidget> createState() => MarkerIconsBodyState();
3333

34-
/// Return the mapId to use for the GoogleMap
34+
/// Returns the mapId to use for the GoogleMap
3535
String? get mapId => null;
3636

37-
/// Create a marker to be displayed on the map
37+
/// Creates a marker to be displayed on the map
3838
Marker createMarker(
3939
MarkerId markerId,
4040
LatLng position,

packages/google_maps_flutter/google_maps_flutter/example/lib/place_advanced_marker.dart

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ import 'main.dart' as main;
99
import 'page.dart';
1010
import 'place_marker.dart';
1111

12-
/// Page demonstrating how to use Advanced [Marker] class
12+
/// Page demonstrating how to use Advanced [Marker] class.
1313
class PlaceAdvancedMarkerPage extends GoogleMapExampleAppPage {
14-
/// Default constructor
14+
/// Default constructor.
1515
const PlaceAdvancedMarkerPage({Key? key})
1616
: super(const Icon(Icons.place_outlined), 'Place advanced marker',
1717
key: key);
@@ -69,7 +69,7 @@ class _PlaceAdvancedMarkerBodyState extends PlaceMarkerBodyState {
6969
}
7070

7171
/// Whether map supports advanced markers. Null indicates capability check
72-
/// is in progress
72+
/// is in progress.
7373
bool? _isAdvancedMarkersAvailable;
7474

7575
@override
@@ -82,7 +82,7 @@ class _PlaceAdvancedMarkerBodyState extends PlaceMarkerBodyState {
8282
true =>
8383
'Map capabilities check result:\nthis map supports advanced markers',
8484
false =>
85-
"Map capabilities check result:\nthis map doesn't support advanced markers. Please check that map Id is provided and correct map renderer is used",
85+
"Map capabilities check result:\nthis map doesn't support advanced markers. Please check that map ID is provided and correct map renderer is used",
8686
},
8787
textAlign: TextAlign.center,
8888
style: Theme.of(context).textTheme.bodyLarge?.copyWith(
@@ -98,7 +98,7 @@ class _PlaceAdvancedMarkerBodyState extends PlaceMarkerBodyState {
9898

9999
@override
100100
Widget build(BuildContext context) {
101-
// Check if map is capable of showing advanced markers
101+
// Check if map is capable of showing advanced markers.
102102
if (controller != null) {
103103
GoogleMapsFlutterPlatform.instance
104104
.isAdvancedMarkersAvailable(mapId: controller!.mapId)

packages/google_maps_flutter/google_maps_flutter/example/lib/place_marker.dart

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -270,10 +270,10 @@ class PlaceMarkerBodyState extends State<PlaceMarkerBody> {
270270
return BytesMapBitmap(bytes.buffer.asUint8List());
271271
}
272272

273-
/// Return the mapId to use for the GoogleMap
273+
/// Returns the mapId to use for the GoogleMap
274274
String? get mapId => null;
275275

276-
/// Create a marker with given parameters
276+
/// Creates a marker with given parameters
277277
Marker createMarker({
278278
required MarkerId markerId,
279279
required LatLng position,
@@ -292,7 +292,7 @@ class PlaceMarkerBodyState extends State<PlaceMarkerBody> {
292292
);
293293
}
294294

295-
/// Perform customizations of the [marker] to mark it as selected or not
295+
/// Performs customizations of the [marker] to mark it as selected or not.
296296
Marker getSelectedMarker(Marker marker, bool isSelected) {
297297
return marker.copyWith(
298298
iconParam: isSelected
@@ -301,7 +301,7 @@ class PlaceMarkerBodyState extends State<PlaceMarkerBody> {
301301
);
302302
}
303303

304-
/// Optional header to be displayed above the map
304+
/// Returns a header to be displayed above the map.
305305
Widget getHeader() => const SizedBox.shrink();
306306

307307
@override

packages/google_maps_flutter/google_maps_flutter/example/lib/readme_sample_advanced_markers.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ class AdvancedMarkersSample extends StatelessWidget {
3535
return const Scaffold(
3636
// #docregion AdvancedMarkersSample
3737
body: GoogleMap(
38-
// Set your Map Id
38+
// Set your Map ID.
3939
mapId: 'my-map-id',
4040

41-
// Let map know that you're using Advanced Markers
41+
// Enable support for Advanced Markers.
4242
markerType: MarkerType.advancedMarker,
4343
// #enddocregion AdvancedMarkersSample
4444
initialCameraPosition: _kGooglePlex,

packages/google_maps_flutter/google_maps_flutter/lib/src/google_map.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ class GoogleMap extends StatefulWidget {
129129
this.onLongPress,
130130
this.mapId,
131131
this.markerType = MarkerType.marker,
132-
@Deprecated('cloudMapId is deprecated. Use mapId instead') this.cloudMapId,
132+
@Deprecated('cloudMapId is deprecated. Use mapId instead.') this.cloudMapId,
133133
});
134134

135135
/// Callback method for when the map is ready to be used.
@@ -361,7 +361,7 @@ class GoogleMap extends StatefulWidget {
361361
///
362362
/// See https://developers.google.com/maps/documentation/get-map-id
363363
/// for more details.
364-
@Deprecated('cloudMapId is deprecated. Use mapId instead')
364+
@Deprecated('cloudMapId is deprecated. Use mapId instead.')
365365
final String? cloudMapId;
366366

367367
/// Indicates whether map should use [AdvancedMarker]s or [Marker]s.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,8 +107,8 @@ void addClusterManager(String clusterManagerId) {
107107
}
108108

109109
/**
110-
* Initialize cluster renderer if it hasn't been initialized before. ClusterManager uses default
111-
* renderer which should be changed to (legacy) renderer or advanced renderer
110+
* Initializes cluster renderer if it hasn't been initialized before. ClusterManager uses default
111+
* renderer which should be changed to (legacy) renderer or advanced renderer.
112112
*/
113113
private void initializeRenderer(ClusterManager<MarkerBuilder> clusterManager) {
114114
final ClusterRenderer<MarkerBuilder> renderer = clusterManager.getRenderer();
@@ -256,7 +256,7 @@ protected void onClusterItemRendered(@NonNull T item, @NonNull Marker marker) {
256256
}
257257
}
258258

259-
/** AdvancedMarkerClusterRenderer is a ClusterRenderer that supports AdvancedMarkers */
259+
/** AdvancedMarkerClusterRenderer is a ClusterRenderer that supports AdvancedMarkers. */
260260
@VisibleForTesting
261261
static class AdvancedMarkerClusterRenderer<T extends MarkerBuilder>
262262
extends DefaultAdvancedMarkersClusterRenderer<T> {

0 commit comments

Comments
 (0)