Update Doc Strings

stadiamaps · Jan 31, 2025 · c0f023c · c0f023c
1 parent 14f8905
commit c0f023c
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 2 deletions.
diff --git a/android/maplibreui/src/main/java/com/stadiamaps/ferrostar/maplibreui/NavigationMapView.kt b/android/maplibreui/src/main/java/com/stadiamaps/ferrostar/maplibreui/NavigationMapView.kt
@@ -36,8 +36,7 @@ import com.stadiamaps.ferrostar.maplibreui.runtime.navigationMapViewCamera
  *   engine.
  * @param snapUserLocationToRoute If true, the user's displayed location will be snapped to the
  *   route line.
- * @param showCompleteRoute If true, the complete route will be displayed. If false, only the
- *   remaining geometry will be displayed on the polyline.
+ * @param navigationPathBuilder The navigation path builder to use for rendering the route line on the MapView.
  * @param onMapReadyCallback A callback that is invoked when the map is ready to be interacted with.
  *   If unspecified, the camera will change to `navigationCamera` if navigation is in progress.
  * @param content Any additional composable map symbol content to render.

diff --git a/...main/java/com/stadiamaps/ferrostar/maplibreui/views/DynamicallyOrientingNavigationView.kt b/...main/java/com/stadiamaps/ferrostar/maplibreui/views/DynamicallyOrientingNavigationView.kt
@@ -53,6 +53,7 @@ import com.stadiamaps.ferrostar.maplibreui.runtime.rememberMapControlsForProgres
  *   engine.
  * @param snapUserLocationToRoute If true, the user's displayed location will be snapped to the
  *   route line.
+ * @param navigationPathBuilder The navigation path builder to use for rendering the route line on the MapView.
  * @param theme The navigation UI theme to use for the view.
  * @param config The configuration for the navigation view.
  * @param views The navigation view component builder to use for the view.

diff --git a/...ibreui/src/main/java/com/stadiamaps/ferrostar/maplibreui/views/LandscapeNavigationView.kt b/...ibreui/src/main/java/com/stadiamaps/ferrostar/maplibreui/views/LandscapeNavigationView.kt
@@ -55,6 +55,7 @@ import kotlinx.coroutines.flow.asStateFlow
  *   engine.
  * @param snapUserLocationToRoute If true, the user's displayed location will be snapped to the
  *   route line.
+ * @param navigationPathBuilder The navigation path builder to use for rendering the route line on the MapView.
  * @param theme The navigation UI theme to use for the view.
  * @param config The configuration for the navigation view.
  * @param views The navigation view component builder to use for the view.

diff --git a/...libreui/src/main/java/com/stadiamaps/ferrostar/maplibreui/views/PortraitNavigationView.kt b/...libreui/src/main/java/com/stadiamaps/ferrostar/maplibreui/views/PortraitNavigationView.kt
@@ -58,6 +58,7 @@ import kotlinx.coroutines.flow.asStateFlow
  *   engine.
  * @param snapUserLocationToRoute If true, the user's displayed location will be snapped to the
  *   route line.
+ * @param navigationPathBuilder The navigation path builder to use for rendering the route line on the MapView.
  * @param theme The navigation UI theme to use for the view.
  * @param config The configuration for the navigation view.
  * @param views The navigation view component builder to use for the view.