Add additional docs to getBackStackEntry()
Ensure that developers looking at the documentation
understand what destination ids are suitable
to be passed to getBackStackEntry().
Test: ./gradlew distDocs
Fixes: 139445254
Change-Id: Ida0a2a362ef9fb7b207acb4a89f1993af44aa174
diff --git a/navigation/navigation-runtime/src/main/java/androidx/navigation/NavController.java b/navigation/navigation-runtime/src/main/java/androidx/navigation/NavController.java
index 4ab77ad..228cc354 100644
--- a/navigation/navigation-runtime/src/main/java/androidx/navigation/NavController.java
+++ b/navigation/navigation-runtime/src/main/java/androidx/navigation/NavController.java
@@ -1149,6 +1149,10 @@
/**
* Gets the topmost {@link NavBackStackEntry} for a destination id.
+ * <p>
+ * This is always safe to use with {@link #getCurrentDestination() the current destination} or
+ * {@link NavDestination#getParent() its parent} or grandparent navigation graphs as these
+ * destinations are guaranteed to be on the back stack.
*
* @param destinationId ID of a destination that exists on the back stack
* @throws IllegalArgumentException if the destination is not on the back stack
