Add KDoc comments

Author: afarber

openmapview/src/main/kotlin/de/afarber/openmapview/CameraPosition.kt

@@ -7,6 +7,16 @@
 
 package de.afarber.openmapview
 
+/**
+ * Represents the camera position for a map.
+ *
+ * Defines where the camera is positioned (target location) and how close
+ * the camera is to the earth's surface (zoom level).
+ *
+ * @property target The location that the camera is pointing at
+ * @property zoom The zoom level, ranging from 2.0 (world view) to 19.0 (street level)
+ * @throws IllegalArgumentException if zoom is outside the valid range
+ */
 data class CameraPosition(
     val target: LatLng,
     val zoom: Double,

openmapview/src/main/kotlin/de/afarber/openmapview/CameraUpdate.kt

@@ -7,28 +7,57 @@
 
 package de.afarber.openmapview
 
+/**
+ * Defines a camera update to be applied to the map.
+ *
+ * Camera updates are created using [CameraUpdateFactory] and applied via
+ * [OpenMapView.moveCamera] or [OpenMapView.animateCamera].
+ *
+ * This is a sealed hierarchy with internal implementations to prevent external subclassing.
+ */
 sealed class CameraUpdate {
+    /**
+     * Updates the camera target to a new location, preserving current zoom.
+     */
     internal data class NewLatLng(
         val target: LatLng,
     ) : CameraUpdate()
 
+    /**
+     * Updates the camera target and zoom level.
+     */
     internal data class NewLatLngZoom(
         val target: LatLng,
         val zoom: Double,
     ) : CameraUpdate()
 
+    /**
+     * Updates the camera to a new position.
+     */
     internal data class NewCameraPosition(
         val position: CameraPosition,
     ) : CameraUpdate()
 
+    /**
+     * Increases zoom level by 1.
+     */
     internal data object ZoomIn : CameraUpdate()
 
+    /**
+     * Decreases zoom level by 1.
+     */
     internal data object ZoomOut : CameraUpdate()
 
+    /**
+     * Sets zoom to a specific level.
+     */
     internal data class ZoomTo(
         val zoom: Double,
     ) : CameraUpdate()
 
+    /**
+     * Adjusts zoom by a relative amount (positive to zoom in, negative to zoom out).
+     */
     internal data class ZoomBy(
         val amount: Double,
     ) : CameraUpdate()

openmapview/src/main/kotlin/de/afarber/openmapview/CameraUpdateFactory.kt

@@ -7,21 +7,72 @@
 
 package de.afarber.openmapview
 
+/**
+ * Factory for creating [CameraUpdate] objects to transform the camera on a map.
+ *
+ * Compatible with Google Maps API. Use these methods to create camera updates
+ * for [OpenMapView.moveCamera] and [OpenMapView.animateCamera].
+ */
 object CameraUpdateFactory {
+    /**
+     * Returns a CameraUpdate that moves the camera to the specified location,
+     * preserving the current zoom level.
+     *
+     * @param target The location to move the camera to
+     * @return A CameraUpdate for the new location
+     */
     fun newLatLng(target: LatLng): CameraUpdate = CameraUpdate.NewLatLng(target)
 
+    /**
+     * Returns a CameraUpdate that moves the camera to the specified location
+     * and sets the zoom level.
+     *
+     * @param target The location to move the camera to
+     * @param zoom The desired zoom level (2.0 to 19.0)
+     * @return A CameraUpdate for the new location and zoom
+     */
     fun newLatLngZoom(
         target: LatLng,
         zoom: Double,
     ): CameraUpdate = CameraUpdate.NewLatLngZoom(target, zoom)
 
+    /**
+     * Returns a CameraUpdate that moves the camera to the specified position.
+     *
+     * @param position The target camera position
+     * @return A CameraUpdate for the new position
+     */
     fun newCameraPosition(position: CameraPosition): CameraUpdate = CameraUpdate.NewCameraPosition(position)
 
+    /**
+     * Returns a CameraUpdate that increases the zoom level by 1.
+     *
+     * @return A CameraUpdate that zooms in
+     */
     fun zoomIn(): CameraUpdate = CameraUpdate.ZoomIn
 
+    /**
+     * Returns a CameraUpdate that decreases the zoom level by 1.
+     *
+     * @return A CameraUpdate that zooms out
+     */
     fun zoomOut(): CameraUpdate = CameraUpdate.ZoomOut
 
+    /**
+     * Returns a CameraUpdate that sets the zoom level to the specified value.
+     *
+     * @param zoom The target zoom level (2.0 to 19.0)
+     * @return A CameraUpdate for the specified zoom level
+     */
     fun zoomTo(zoom: Double): CameraUpdate = CameraUpdate.ZoomTo(zoom)
 
+    /**
+     * Returns a CameraUpdate that adjusts the zoom level by the specified amount.
+     *
+     * Positive values zoom in, negative values zoom out.
+     *
+     * @param amount The amount to adjust the zoom level (e.g., 1.5 or -2.0)
+     * @return A CameraUpdate for the relative zoom adjustment
+     */
     fun zoomBy(amount: Double): CameraUpdate = CameraUpdate.ZoomBy(amount)
 }

openmapview/src/main/kotlin/de/afarber/openmapview/LatLng.kt

@@ -7,6 +7,15 @@
 
 package de.afarber.openmapview
 
+/**
+ * An immutable class representing a pair of latitude and longitude coordinates.
+ *
+ * Compatible with Google Maps API. Latitude ranges from -90 to 90 degrees,
+ * and longitude ranges from -180 to 180 degrees.
+ *
+ * @property latitude The latitude in degrees
+ * @property longitude The longitude in degrees
+ */
 data class LatLng(
     val latitude: Double,
     val longitude: Double,