improve onRoutesChanged docs

dzinad · dzinad · commit b229a9bf04cf · 2022-07-25T15:54:41.000+03:00
diff --git a/libnavigation-core/src/main/java/com/mapbox/navigation/core/directions/session/RoutesObserver.kt b/libnavigation-core/src/main/java/com/mapbox/navigation/core/directions/session/RoutesObserver.kt
@@ -11,7 +11,8 @@ import com.mapbox.navigation.core.MapboxNavigation
 fun interface RoutesObserver {
 
     /**
-     * Invoked whenever a list of routes changes.
+     * Invoked whenever a list of routes changes and immediately when registered
+     * (see [MapboxNavigation.registerRoutesObserver]) if non-empty routes are present.
      *
      * The route at index 0, if exist, will be treated as the primary route for 'Active Guidance'.
      *

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,8 @@ import com.mapbox.navigation.core.MapboxNavigation`
`11`	`11`	`fun interface RoutesObserver {`
`12`	`12`
`13`	`13`	`/**`
`14`		`- * Invoked whenever a list of routes changes.`
	`14`	`+ * Invoked whenever a list of routes changes and immediately when registered`
	`15`	`+ * (see [MapboxNavigation.registerRoutesObserver]) if non-empty routes are present.`
`15`	`16`	`*`
`16`	`17`	`* The route at index 0, if exist, will be treated as the primary route for 'Active Guidance'.`
`17`	`18`	`*`