docs: description for contains method

maplibre · Oct 3, 2024 · 4f8aa72 · 4f8aa72
1 parent cce99d0
commit 4f8aa72
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/maplibre_gl_platform_interface/lib/src/location.dart b/maplibre_gl_platform_interface/lib/src/location.dart
@@ -84,6 +84,10 @@ class LatLngBounds {
     return <dynamic>[southwest.toJson(), northeast.toJson()];
   }
 
+  /// Determines whether a given geographical point (`LatLng`) is within the
+  /// bounds defined by two other geographical points: `southwest` (lower-left corner)
+  /// and `northeast` (upper-right corner).
+  ///
   bool contains(LatLng point) {
     final isLatitudeInBounds = point.latitude >= southwest.latitude &&
         point.latitude <= northeast.latitude;