Fix ktlint and docs.

publish_android_snapshot

Author: pengdev

app/src/main/java/com/mapbox/maps/testapp/examples/location/MultipleLocationComponentActivity.kt

@@ -2,10 +2,6 @@ package com.mapbox.maps.testapp.examples.location
 
 import android.annotation.SuppressLint
 import android.os.Bundle
-import android.view.ViewGroup
-import android.view.ViewGroup.LayoutParams.WRAP_CONTENT
-import android.widget.Button
-import android.widget.LinearLayout
 import androidx.appcompat.app.AppCompatActivity
 import com.mapbox.geojson.Point
 import com.mapbox.maps.*
@@ -19,14 +15,11 @@ import com.mapbox.maps.plugin.locationcomponent.CustomJourneyLocationProvider
 import com.mapbox.maps.plugin.locationcomponent.Journey
 import com.mapbox.maps.plugin.locationcomponent.LocationComponentInitOptions
 import com.mapbox.maps.plugin.locationcomponent.LocationComponentPlugin2
-import com.mapbox.maps.plugin.viewport.data.FollowPuckViewportStateBearing
-import com.mapbox.maps.plugin.viewport.data.FollowPuckViewportStateOptions
 import com.mapbox.maps.plugin.viewport.data.MultiPuckViewportStateBearing
 import com.mapbox.maps.plugin.viewport.data.MultiPuckViewportStateOptions
 import com.mapbox.maps.plugin.viewport.state.MultiPuckViewportState
 import com.mapbox.maps.plugin.viewport.viewport
 import com.mapbox.maps.testapp.R
-import com.mapbox.maps.testapp.databinding.ActivityMultiDisplayBinding
 import com.mapbox.maps.testapp.databinding.ActivityMultiLocationcomponentBinding
 import com.mapbox.maps.testapp.utils.BitmapUtils
 import com.mapbox.maps.testapp.utils.createLocationComponent

plugin-locationcomponent/src/main/java/com/mapbox/maps/plugin/locationcomponent/CustomJourneyLocationProvider.kt

@@ -17,6 +17,9 @@ import kotlin.math.*
 class CustomJourneyLocationProvider : LocationProvider {
   private var locationConsumers = CopyOnWriteArraySet<LocationConsumer>()
 
+  /**
+   * Load a journey to the CustomJourneyLocationProvider.
+   */
   fun loadJourney(journey: Journey) {
     journey.observeJourneyUpdates { point, bearing, locationAnimationDurationMs, bearingAnimationDurationMs ->
       emitLocationUpdated(point, bearing, locationAnimationDurationMs, bearingAnimationDurationMs)
@@ -41,17 +44,35 @@ class CustomJourneyLocationProvider : LocationProvider {
     }
   }
 
+  /**
+   * Handling of registered location consumers.
+   */
   override fun registerLocationConsumer(locationConsumer: LocationConsumer) {
     this.locationConsumers.add(locationConsumer)
   }
 
+  /**
+   * Handling of unregistered location consumer.
+   */
   override fun unRegisterLocationConsumer(locationConsumer: LocationConsumer) {
     this.locationConsumers.remove(locationConsumer)
   }
 }
 
+/**
+ * Abstraction of a Journey.
+ */
 @MapboxExperimental
-class Journey(val speed: Double = 100.0, val angularSpeed: Double = 500.0) {
+class Journey(
+  /**
+   * The speed to playback the journey.
+   */
+  val speed: Double = 100.0,
+  /**
+   * The angular speed to playback the journey.
+   */
+  val angularSpeed: Double = 500.0
+) {
   private val locationList = CopyOnWriteArrayList<QueueData>()
   private val initialTimeStamp: Long = 0
   private val remainingPoints = ConcurrentLinkedQueue<QueueData>()
@@ -70,6 +91,9 @@ class Journey(val speed: Double = 100.0, val angularSpeed: Double = 500.0) {
       }
     }
 
+  /**
+   * Observe the journey updates.
+   */
   fun observeJourneyUpdates(observer: JourneyDataObserver) {
     observers.add(observer)
   }
@@ -120,7 +144,12 @@ class Journey(val speed: Double = 100.0, val angularSpeed: Double = 500.0) {
       (distanceInMeter(it, location) / speed) * 1000.0
     } ?: 1000L
     val bearingAnimateDurationMs =
-      abs(shortestRotation(bearing, locationList.lastOrNull()?.bearing ?: 0.0) / angularSpeed) * 1000.0
+      abs(
+        shortestRotation(
+          bearing,
+          locationList.lastOrNull()?.bearing ?: 0.0
+        ) / angularSpeed
+      ) * 1000.0
 
     val nextData =
       QueueData(location, bearing, animationDurationMs.toLong(), bearingAnimateDurationMs.toLong())
@@ -235,6 +264,9 @@ class Journey(val speed: Double = 100.0, val angularSpeed: Double = 500.0) {
   }
 }
 
+/**
+ * Defines the interface to observe the journey data uppdates.
+ */
 fun interface JourneyDataObserver {
   /**
    * Notifies that new data is available.

plugin-locationcomponent/src/main/java/com/mapbox/maps/plugin/locationcomponent/LocationComponentInitOptions.kt

@@ -6,29 +6,47 @@ import com.mapbox.maps.plugin.locationcomponent.LocationComponentConstants.MODEL
 import com.mapbox.maps.plugin.locationcomponent.LocationComponentConstants.MODEL_SOURCE
 import com.mapbox.maps.plugin.locationcomponent.LocationComponentConstants.SHADOW_ICON
 import com.mapbox.maps.plugin.locationcomponent.LocationComponentConstants.TOP_ICON
-import java.util.Objects
-import kotlin.Any
-import kotlin.Boolean
-import kotlin.Int
-import kotlin.String
-import kotlin.Unit
-import kotlin.jvm.JvmSynthetic
+import java.util.*
 
 /**
  * Initialisation options for location component to allow multiple instances
  * of LocationComponent.
  */
 public class LocationComponentInitOptions private constructor(
+  /**
+   * The layer id of the location indicator layer used to draw the 2d puck.
+   */
   public val puck2DLayerId: String,
+  /**
+   * The layer id of the model layer used to draw the 3d puck.
+   */
   public val puck3DLayerId: String,
+  /**
+   * The source id of the model layer used to draw the 3d puck.
+   */
   public val puck3DSourceId: String,
+  /**
+   * The top icon image id for the 2d puck.
+   */
   public val topIconImageId: String,
+  /**
+   * The shadow icon image id for the 2d puck.
+   */
   public val shadowIconImageId: String,
+  /**
+   * The bearing icon image id for the 2d puck.
+   */
   public val bearingIconImageId: String
 ) {
+  /**
+   * Convert the LocationComponentInitOptions to a String.
+   */
   public override fun toString() =
     "LocationComponentInitOptions(puck2DLayerId=$puck2DLayerId,puck3DLayerId=$puck3DLayerId, puck3DSourceId=$puck3DSourceId, topIconImageId=$topIconImageId,shadowIconImageId=$shadowIconImageId, bearingIconImageId=$bearingIconImageId)"
 
+  /**
+   * Compares two LocationComponentOptions.
+   */
   public override fun equals(other: Any?): Boolean = other is LocationComponentInitOptions &&
     puck2DLayerId == other.puck2DLayerId &&
     puck3DLayerId == other.puck3DLayerId &&
@@ -37,11 +55,17 @@ public class LocationComponentInitOptions private constructor(
     shadowIconImageId == other.shadowIconImageId &&
     bearingIconImageId == other.bearingIconImageId
 
+  /**
+   * The hashcode of the LocationComponentOptions.
+   */
   public override fun hashCode(): Int = Objects.hash(
     puck2DLayerId, puck3DLayerId, puck3DSourceId,
     topIconImageId, shadowIconImageId, bearingIconImageId
   )
 
+  /**
+   * Convert LocationComponentOptions to a Builder.
+   */
   public fun toBuilder(): Builder = Builder()
     .setPuck2DLayerId(this.puck2DLayerId)
     .setPuck3DLayerId(this.puck3DLayerId)
@@ -58,21 +82,39 @@ public class LocationComponentInitOptions private constructor(
    * @property
    */
   public class Builder {
+    /**
+     * The layer id of the location indicator layer used to draw the 2d puck.
+     */
     @set:JvmSynthetic
     public var puck2DLayerId: String = LOCATION_INDICATOR_LAYER
 
+    /**
+     * The layer id of the model layer used to draw the 3d puck.
+     */
     @set:JvmSynthetic
     public var puck3DLayerId: String = MODEL_LAYER
 
+    /**
+     * The source id of the model layer used to draw the 3d puck.
+     */
     @set:JvmSynthetic
     public var puck3DSourceId: String = MODEL_SOURCE
 
+    /**
+     * The top icon image id for the 2d puck.
+     */
     @set:JvmSynthetic
     public var topIconImageId: String = TOP_ICON
 
+    /**
+     * The shadow icon image id for the 2d puck.
+     */
     @set:JvmSynthetic
     public var shadowIconImageId: String = SHADOW_ICON
 
+    /**
+     * The bearing icon image id for the 2d puck.
+     */
     @set:JvmSynthetic
     public var bearingIconImageId: String = BEARING_ICON
 
@@ -158,9 +200,15 @@ public class LocationComponentInitOptions private constructor(
     }
   }
 
+  /**
+   * Companion object of [LocationComponentInitOptions].
+   */
   companion object {
     private var customLocationComponentCount = 0
 
+    /**
+     * Create a unique LocationComponentInitOptions with incremental layer/source/image ids.
+     */
     @JvmStatic
     fun getNextUniqueLocationComponentOptions() = LocationComponentInitOptions {
       puck2DLayerId = "custom_location_component_2d_layer_$customLocationComponentCount"

plugin-locationcomponent/src/main/java/com/mapbox/maps/plugin/locationcomponent/LocationComponentPluginImpl.kt

@@ -13,7 +13,6 @@ import com.mapbox.maps.extension.style.StyleInterface
 import com.mapbox.maps.plugin.delegates.MapDelegateProvider
 import com.mapbox.maps.plugin.locationcomponent.animators.PuckAnimatorManager
 import com.mapbox.maps.plugin.locationcomponent.generated.*
-import com.mapbox.maps.plugin.locationcomponent.generated.LocationComponentAttributeParser
 import java.lang.ref.WeakReference
 import java.util.concurrent.CopyOnWriteArraySet
 
@@ -22,6 +21,9 @@ import java.util.concurrent.CopyOnWriteArraySet
  * to the user's current location.
  */
 class LocationComponentPluginImpl(
+  /**
+   * The initialisation options for the location component, defaults to the default LocationComponent configurations.
+   */
   val locationComponentInitOptions: LocationComponentInitOptions = LocationComponentInitOptions.Builder()
     .build()
 ) : LocationComponentPlugin2, LocationConsumer2,

plugin-viewport/src/main/kotlin/com/mapbox/maps/plugin/viewport/ViewportPluginImpl.kt

@@ -234,6 +234,12 @@ class ViewportPluginImpl(private val handler: Handler = Handler(Looper.getMainLo
     return FollowPuckViewportStateImpl(delegateProvider, options)
   }
 
+  /**
+   * Create a new [MultiPuckViewportState] instance with provided [MultiPuckViewportStateOptions].
+   *
+   * @param options The desired [MultiPuckViewportStateOptions], defaults to [MultiPuckViewportStateOptions] that's initialised with default parameters.
+   * @return The newly-created [MultiPuckViewportState] instance.
+   */
   override fun makeMultiPuckViewportState(
     options: MultiPuckViewportStateOptions,
     locationComponents: List<LocationComponentPlugin2>

plugin-viewport/src/main/kotlin/com/mapbox/maps/plugin/viewport/state/MultiPuckViewportStateImpl.kt

@@ -8,7 +8,6 @@ import com.mapbox.geojson.MultiPoint
 import com.mapbox.geojson.Point
 import com.mapbox.maps.CameraOptions
 import com.mapbox.maps.EdgeInsets
-import com.mapbox.maps.logE
 import com.mapbox.maps.logW
 import com.mapbox.maps.plugin.animation.Cancelable
 import com.mapbox.maps.plugin.animation.camera
@@ -105,8 +104,7 @@ internal class MultiPuckViewportStateImpl(
       with(options.bearing) {
         when (this) {
           is MultiPuckViewportStateBearing.Constant -> bearing
-          is MultiPuckViewportStateBearing.SyncWithLocationPuck -> lastBearings[locationComponent]
-            ?: 0.0
+          is MultiPuckViewportStateBearing.SyncWithLocationPuck -> lastBearings[locationComponent] ?: 0.0
           else -> 0.0
         }
       },

sdk-base/src/main/java/com/mapbox/maps/plugin/viewport/ViewportPlugin.kt

@@ -120,6 +120,12 @@ interface ViewportPlugin : MapPlugin {
     options: FollowPuckViewportStateOptions = FollowPuckViewportStateOptions.Builder().build()
   ): FollowPuckViewportState
 
+  /**
+   * Create a new [MultiPuckViewportState] instance with provided [MultiPuckViewportStateOptions].
+   *
+   * @param options The desired [MultiPuckViewportStateOptions], defaults to [MultiPuckViewportStateOptions] that's initialised with default parameters.
+   * @return The newly-created [MultiPuckViewportState] instance.
+   */
   fun makeMultiPuckViewportState(
     options: MultiPuckViewportStateOptions = MultiPuckViewportStateOptions.Builder().build(),
     locationComponents: List<LocationComponentPlugin2>

sdk-base/src/main/java/com/mapbox/maps/plugin/viewport/data/MultiPuckViewportStateBearing.kt

@@ -3,7 +3,7 @@ package com.mapbox.maps.plugin.viewport.data
 import com.mapbox.maps.CameraOptions
 import com.mapbox.maps.plugin.locationcomponent.LocationComponentPlugin2
 import com.mapbox.maps.plugin.viewport.state.MultiPuckViewportState
-import java.util.Objects
+import java.util.*
 
 /**
  * Describes different ways that [MultiPuckViewportState] can obtain values to use when setting
@@ -38,11 +38,17 @@ sealed class MultiPuckViewportStateBearing {
    * When set to this mode, the viewport's bearing is driven by the location, thus guarantees
    * the synchronization of the location puck and camera position.
    */
-  class SyncWithLocationPuck(val locationComponent: LocationComponentPlugin2) : MultiPuckViewportStateBearing() {
+  class SyncWithLocationPuck(
+    /**
+     * The location component instance to be synced with.
+     */
+    val locationComponent: LocationComponentPlugin2
+  ) : MultiPuckViewportStateBearing() {
     /**
      * Indicates whether some other object is "equal to" this one.
      */
-    override fun equals(other: Any?) = other is SyncWithLocationPuck && locationComponent == other.locationComponent
+    override fun equals(other: Any?) =
+      other is SyncWithLocationPuck && locationComponent == other.locationComponent
 
     /**
      * Returns a hash code value for the object.

sdk-base/src/main/java/com/mapbox/maps/plugin/viewport/state/MultiPuckViewportState.kt

@@ -2,7 +2,6 @@ package com.mapbox.maps.plugin.viewport.state
 
 import com.mapbox.maps.plugin.locationcomponent.LocationComponentPlugin
 import com.mapbox.maps.plugin.viewport.ViewportPlugin
-import com.mapbox.maps.plugin.viewport.data.FollowPuckViewportStateOptions
 import com.mapbox.maps.plugin.viewport.data.MultiPuckViewportStateOptions
 
 /**