mapbox-navigation-android icon indicating copy to clipboard operation
mapbox-navigation-android copied to clipboard

KDocs Issues in MapboxRouteArrowApi

Open commonsguy opened this issue 1 year ago • 0 comments

In com.mapbox.navigationcore:ui-maps:3.2.0, the KDocs for MapboxRouteArrowApi have a couple of issues.

First, the initial code snippets show withAboveLayerId(), which is deprecated:

 * RouteArrowOptions routeArrowOptions = new RouteArrowOptions.Builder(context)
 *  .withAboveLayerId(RouteLayerConstants.TOP_LEVEL_ROUTE_LINE_LAYER_ID)
 *  .build()
 * MapboxRouteArrowApi routeArrow = new MapboxRouteArrowApi()
 * MapboxRouteArrowView routeArrowView = new MapboxRouteArrowView(routeArrowOptions)
 * val routeArrowOptions = RouteArrowOptions.Builder(context)
 *      .withAboveLayerId(RouteLayerConstants.TOP_LEVEL_ROUTE_LINE_LAYER_ID)
 *      .build()
 * val routeArrow = MapboxRouteArrowApi()
 * val routeArrowView = MapboxRouteArrowView(routeArrowOptions)

Also, the final code snippet shows a updateUpcomingManeuverArrow() that does not exist:

 * override fun onRouteProgressChanged(routeProgress: RouteProgress) {
 * val updateState = routeArrow.updateUpcomingManeuverArrow(routeProgress)
 * routeArrowView.render(mapboxMap.getStyle(), updateState)

commonsguy avatar Aug 01 '24 14:08 commonsguy