Add API doc

hotwired · Nov 26, 2024 · 9816065 · 9816065
1 parent a98f261
commit 9816065
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/navigation-fragments/src/main/java/dev/hotwire/navigation/navigator/NavigatorHost.kt b/navigation-fragments/src/main/java/dev/hotwire/navigation/navigator/NavigatorHost.kt
@@ -27,6 +27,11 @@ open class NavigatorHost : NavHostFragment() {
         activity.delegate.unregisterNavigatorHost(this)
     }
 
+    /**
+     * Returns whether the navigation host is ready for navigation. It is not
+     * ready for navigation if the view is not attached or the start destination
+     * has not been created yet.
+     */
     fun isReady(): Boolean {
         return isAdded && !isDetached && childFragmentManager.primaryNavigationFragment != null
     }