Skip to content

Commit dac2b27

Browse files
authored
Fix grammar in Overlay Plugin descriptions (#2981)
1 parent 79abcf5 commit dac2b27

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

plugin-overlay/src/main/java/com/mapbox/maps/plugin/overlay/MapOverlayPluginImpl.kt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ internal class MapOverlayPluginImpl : MapOverlayPlugin {
4646
}
4747

4848
/**
49-
* Register an MapOverlay instance.
49+
* Register a MapOverlay instance.
5050
* @param overlay the registered overlay view
5151
*/
5252
override fun registerOverlay(overlay: View) {
@@ -62,7 +62,7 @@ internal class MapOverlayPluginImpl : MapOverlayPlugin {
6262
}
6363

6464
/**
65-
* Unregister an MapOverlay instance.
65+
* Unregister a MapOverlay instance.
6666
* @param overlay the unregistered overlay view
6767
*/
6868
override fun unregisterOverlay(overlay: View) {
@@ -80,8 +80,8 @@ internal class MapOverlayPluginImpl : MapOverlayPlugin {
8080
}
8181

8282
/**
83-
* Set the margins for the area that displaying import POIs without covered. These margins can let the
84-
* POIs near the border not by cut or covered.
83+
* Set the margins for the area that is displaying POIs within the overlay bounds.
84+
* These margins provide offsets to ensure POIs near the border of the overlay not be hidden or covered.
8585
* @param marginLeft the margin on the left, in pixel
8686
* @param marginTop the margin on the top, in pixel
8787
* @param marginRight the margin on the right, in pixel
@@ -101,7 +101,7 @@ internal class MapOverlayPluginImpl : MapOverlayPlugin {
101101

102102
/**
103103
* Reframe MapView to a certain zoom and position to make sure every coordinate will be shown
104-
* on the MapView and not covered by registered MapOverlays.
104+
* on the MapView and not be covered by registered MapOverlays.
105105
* If no onAnimateReframe is provided, MapView will jump to the new CameraOptions directly;
106106
* if onAnimateReframe is provided, the new CameraOptions will be return and users can define their
107107
* own animation to move the camera.
@@ -122,8 +122,8 @@ internal class MapOverlayPluginImpl : MapOverlayPlugin {
122122

123123
/**
124124
* Get the CameraOptions that make sure every coordinate will be shown
125-
* on the MapView and not covered by registered MapOverlays.
126-
* Users can use their own animation to move camera with this CameraOptions.
125+
* on the MapView and not be covered by registered MapOverlays.
126+
* Users can use their own animation to move the camera with this CameraOptions.
127127
*
128128
* @param result callback with CameraOptions that MapView should animate to.
129129
* Will be null if MapOverlayCoordinatesProvider is not provided.
@@ -224,7 +224,7 @@ internal class MapOverlayPluginImpl : MapOverlayPlugin {
224224
}
225225

226226
/**
227-
* Class represent the rectangle of MapOverlays on MapView
227+
* Class that represents the rectangle of MapOverlays on MapView
228228
*/
229229
@RestrictTo(RestrictTo.Scope.LIBRARY)
230230
internal class MapOverLayRect(

sdk-base/src/main/java/com/mapbox/maps/plugin/overlay/MapOverlayPlugin.kt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ interface MapOverlayPlugin : MapSizePlugin, MapPlugin {
2121
fun unregisterMapOverlayCoordinatesProvider()
2222

2323
/**
24-
* Register an view as overlay.
24+
* Register a view as overlay.
2525
* @param overlay the registered overlay view
2626
*/
2727
fun registerOverlay(overlay: View)
@@ -33,7 +33,7 @@ interface MapOverlayPlugin : MapSizePlugin, MapPlugin {
3333
fun registerOverlays(overlays: List<View>)
3434

3535
/**
36-
* Unregister an view.
36+
* Unregister a view.
3737
* @param overlay the unregistered overlay view
3838
*/
3939
fun unregisterOverlay(overlay: View)
@@ -45,8 +45,8 @@ interface MapOverlayPlugin : MapSizePlugin, MapPlugin {
4545
fun unregisterOverlays(overlays: List<View>)
4646

4747
/**
48-
* Set the margins for the area that displaying import POIs without covered. These margins can let the
49-
* POIs near the border not by cut or covered.
48+
* Set the margins for the area that is displaying POIs within the overlay bounds.
49+
* These margins provide offsets to ensure POIs near the border of the overlay not be hidden or covered.
5050
* @param marginTop the margin on the top, in pixel
5151
* @param marginLeft the margin on the left, in pixel
5252
* @param marginBottom the margin on the bottom, in pixel
@@ -56,7 +56,7 @@ interface MapOverlayPlugin : MapSizePlugin, MapPlugin {
5656

5757
/**
5858
* Reframe MapView to a certain zoom and position to make sure every coordinate will be shown
59-
* on the MapView and not covered by registered MapOverlays.
59+
* on the MapView and not be covered by registered MapOverlays.
6060
* If no [OnReframeFinished] object is provided, MapView will jump to the new [CameraOptions] directly;
6161
* if [OnReframeFinished] object is provided, the new [CameraOptions] will be return and users can define their
6262
* own animation to move the camera.

0 commit comments

Comments
 (0)