Add READMEs for each recipe.

dturner · dturner · commit 0c7b01bebe81 · 2025-11-11T21:54:46.000Z
Remove duplicate content from Activity kdocs.
diff --git a/app/src/main/java/com/example/nav3recipes/animations/AnimatedActivity.kt b/app/src/main/java/com/example/nav3recipes/animations/AnimatedActivity.kt
@@ -25,11 +25,6 @@ import com.example.nav3recipes.ui.setEdgeToEdgeConfig
 import kotlinx.serialization.Serializable
 
 
-/**
- * This recipe shows how to override the default animations at the `NavDisplay` level, and at the
- * individual destination level, shown for `ScreenC`.
- *
- */
 @Serializable
 private data object ScreenA : NavKey
 
diff --git a/app/src/main/java/com/example/nav3recipes/basic/BasicActivity.kt b/app/src/main/java/com/example/nav3recipes/basic/BasicActivity.kt
@@ -29,10 +29,6 @@ import com.example.nav3recipes.content.ContentBlue
 import com.example.nav3recipes.content.ContentGreen
 import com.example.nav3recipes.ui.setEdgeToEdgeConfig
 
-/**
- * Basic example with two screens, showing how to use the Navigation 3 API.
- */
-
 private data object RouteA
 
 private data class RouteB(val id: String)
diff --git a/app/src/main/java/com/example/nav3recipes/basicdsl/BasicDslActivity.kt b/app/src/main/java/com/example/nav3recipes/basicdsl/BasicDslActivity.kt
@@ -30,10 +30,6 @@ import com.example.nav3recipes.content.ContentGreen
 import com.example.nav3recipes.ui.setEdgeToEdgeConfig
 import kotlinx.serialization.Serializable
 
-/**
- * Basic example with two screens that uses the entryProvider DSL and has a persistent back stack.
- */
-
 @Serializable
 private data object RouteA : NavKey
 
diff --git a/app/src/main/java/com/example/nav3recipes/basicsaveable/BasicSaveableActivity.kt b/app/src/main/java/com/example/nav3recipes/basicsaveable/BasicSaveableActivity.kt
@@ -30,13 +30,6 @@ import com.example.nav3recipes.content.ContentGreen
 import com.example.nav3recipes.ui.setEdgeToEdgeConfig
 import kotlinx.serialization.Serializable
 
-/**
- * Basic example with a persistent back stack state.
- *
- * The back stack persists config changes because it's created using `rememberNavBackStack`. This
- * requires that the back stack keys be both serializable and implement `NavKey`.
- */
-
 @Serializable
 private data object RouteA : NavKey
 
diff --git a/app/src/main/java/com/example/nav3recipes/bottomsheet/BottomSheetActivity.kt b/app/src/main/java/com/example/nav3recipes/bottomsheet/BottomSheetActivity.kt
@@ -36,16 +36,6 @@ import com.example.nav3recipes.content.ContentGreen
 import com.example.nav3recipes.ui.setEdgeToEdgeConfig
 import kotlinx.serialization.Serializable
 
-/**
- * This recipe demonstrates how to create a bottom sheet. It does this by:
- *
- * - Adding the `BottomSheetSceneStrategy` to the list of strategies used by `NavDisplay`.
- * - Adding `BottomSheetSceneStrategy.bottomSheet()` to a `NavEntry`'s metadata to indicate that it
- * is a bottom sheet. In this case it is applied to the `NavEntry` for `RouteB`.
- *
- * See also https://developer.android.com/guide/navigation/navigation-3/custom-layouts
- */
-
 @Serializable
 private data object RouteA : NavKey
 
diff --git a/app/src/main/java/com/example/nav3recipes/commonui/CommonUiActivity.kt b/app/src/main/java/com/example/nav3recipes/commonui/CommonUiActivity.kt
@@ -44,19 +44,6 @@ import com.example.nav3recipes.content.ContentPurple
 import com.example.nav3recipes.content.ContentRed
 import com.example.nav3recipes.ui.setEdgeToEdgeConfig
 
-/**
- * Common navigation UI example. This app has three top level routes: Home, ChatList and Camera.
- * ChatList has a sub-route: ChatDetail.
- *
- * The app back stack state is modeled in `TopLevelBackStack`. This creates a back stack for each
- * top level route. It flattens those maps to create a single back stack for `NavDisplay`. This allows
- * `NavDisplay` to know where to go back to.
- *
- * Note that in this example, the Home route can move above the ChatList and Camera routes, meaning
- * navigating back from Home doesn't necessarily leave the app. The app will exit when the user goes
- * back from a single remaining top level route in the back stack.
- */
-
 private sealed interface TopLevelRoute {
     val icon: ImageVector
 }
diff --git a/app/src/main/java/com/example/nav3recipes/conditional/ConditionalActivity.kt b/app/src/main/java/com/example/nav3recipes/conditional/ConditionalActivity.kt
@@ -33,16 +33,6 @@ import com.example.nav3recipes.content.ContentBlue
 import com.example.nav3recipes.content.ContentGreen
 import com.example.nav3recipes.content.ContentYellow
 
-/**
- * Conditional navigation recipe.
- *
- * In this app we have a destination, Profile, that can only be
- * accessed once the user has logged in. If they attempt to access the Profile destination when
- * they're not logged in, they are redirected to the Login destination. Their ultimate destination,
- * Profile, is saved. Once they're logged in, they're taken to the Profile destination.
- *
- */
-
 private data object Home
 
 // A marker interface is used to mark any routes that require login
diff --git a/app/src/main/java/com/example/nav3recipes/dialog/DialogActivity.kt b/app/src/main/java/com/example/nav3recipes/dialog/DialogActivity.kt
@@ -37,16 +37,6 @@ import com.example.nav3recipes.content.ContentGreen
 import com.example.nav3recipes.ui.setEdgeToEdgeConfig
 import kotlinx.serialization.Serializable
 
-/**
- * This recipe demonstrates how to create a dialog. It does this by:
- *
- * - Adding the `DialogSceneStrategy` to the list of strategies used by `NavDisplay`.
- * - Adding `DialogSceneStrategy.dialog` to a `NavEntry`'s metadata to indicate that it is a
- * dialog. In this case it is applied to the `NavEntry` for `RouteB`.
- *
- * See also https://developer.android.com/guide/navigation/navigation-3/custom-layouts
- */
-
 @Serializable
 private data object RouteA : NavKey
 
diff --git a/app/src/main/java/com/example/nav3recipes/material/listdetail/MaterialListDetailActivity.kt b/app/src/main/java/com/example/nav3recipes/material/listdetail/MaterialListDetailActivity.kt
@@ -41,11 +41,6 @@ import com.example.nav3recipes.content.ContentYellow
 import com.example.nav3recipes.ui.setEdgeToEdgeConfig
 import kotlinx.serialization.Serializable
 
-/**
- * This example uses the Material ListDetailSceneStrategy to create an adaptive scene. It has three
- * destinations: ConversationList, ConversationDetail and Profile. When the window width allows it,
- * the content for these destinations will be shown in a two pane layout.
- */
 @Serializable
 private object ConversationList : NavKey
 
diff --git a/app/src/main/java/com/example/nav3recipes/material/supportingpane/MaterialSupportingPaneActivity.kt b/app/src/main/java/com/example/nav3recipes/material/supportingpane/MaterialSupportingPaneActivity.kt
@@ -41,11 +41,6 @@ import com.example.nav3recipes.content.ContentRed
 import com.example.nav3recipes.ui.setEdgeToEdgeConfig
 import kotlinx.serialization.Serializable
 
-/**
- * This example uses the Material SupportingPaneSceneStrategy to create an adaptive scene. It has three
- * destinations: Content, RelatedContent and Profile. When the window width allows it,
- * the content for these destinations will be shown in a two pane layout.
- */
 @Serializable
 private object MainVideo : NavKey
 
diff --git a/app/src/main/java/com/example/nav3recipes/modular/hilt/ModularActivity.kt b/app/src/main/java/com/example/nav3recipes/modular/hilt/ModularActivity.kt
@@ -12,20 +12,6 @@ import com.example.nav3recipes.ui.setEdgeToEdgeConfig
 import dagger.hilt.android.AndroidEntryPoint
 import javax.inject.Inject
 
-/**
- * This recipe demonstrates how to use a modular approach with Navigation 3,
- * where different parts of the application are defined in separate modules and injected
- * into the main app using Dagger/Hilt.
- * 
- * Features (Conversation and Profile) are split into two modules: 
- * - api: defines the public facing routes for this feature
- * - impl: defines the entryProviders for this feature, these are injected into the app's main activity
- * The common module defines:
- * - a common navigator class that exposes a back stack and methods to modify that back stack
- * - a type that should be used by feature modules to inject entryProviders into the app's main activity
- * The app module creates the navigator by supplying a start destination and provides this navigator
- * to the rest of the app module (i.e. MainActivity) and the feature modules.
- */
 @AndroidEntryPoint
 class ModularActivity : ComponentActivity() {
 
diff --git a/app/src/main/java/com/example/nav3recipes/passingarguments/viewmodels/basic/BasicViewModelsActivity.kt b/app/src/main/java/com/example/nav3recipes/passingarguments/viewmodels/basic/BasicViewModelsActivity.kt
@@ -36,11 +36,6 @@ import com.example.nav3recipes.content.ContentBlue
 import com.example.nav3recipes.content.ContentGreen
 import com.example.nav3recipes.ui.setEdgeToEdgeConfig
 
-/**
- * Passing navigation arguments to a ViewModel.
- *
- * - ViewModelStoreNavEntryDecorator ensures that ViewModels are scoped to the NavEntry
- */
 data object RouteA
 
 data class RouteB(val id: String)
diff --git a/app/src/main/java/com/example/nav3recipes/passingarguments/viewmodels/hilt/HiltViewModelsActivity.kt b/app/src/main/java/com/example/nav3recipes/passingarguments/viewmodels/hilt/HiltViewModelsActivity.kt
@@ -41,13 +41,6 @@ import dagger.assisted.AssistedInject
 import dagger.hilt.android.AndroidEntryPoint
 import dagger.hilt.android.lifecycle.HiltViewModel
 
-/**
- * Passing navigation arguments to a Hilt injected ViewModel
- *
- * - ViewModelStoreNavEntryDecorator ensures that ViewModels are scoped to the NavEntry
- * - Assisted injection is used to construct ViewModels with the navigation key
- */
-
 data object RouteA
 data class RouteB(val id: String)
 
diff --git a/app/src/main/java/com/example/nav3recipes/passingarguments/viewmodels/koin/KoinViewModelsActivity.kt b/app/src/main/java/com/example/nav3recipes/passingarguments/viewmodels/koin/KoinViewModelsActivity.kt
@@ -24,12 +24,6 @@ import org.koin.core.module.dsl.viewModelOf
 import org.koin.core.parameter.parametersOf
 import org.koin.dsl.module
 
-/**
- * Passing navigation arguments to a Koin injected ViewModel
- *
- * - ViewModelStoreNavEntryDecorator ensures that ViewModels are scoped to the NavEntry
- */
-
 data object RouteA
 data class RouteB(val id: String)
 
diff --git a/app/src/main/java/com/example/nav3recipes/results/event/ResultEventActivity.kt b/app/src/main/java/com/example/nav3recipes/results/event/ResultEventActivity.kt
@@ -35,13 +35,6 @@ import com.example.nav3recipes.results.common.Person
 import com.example.nav3recipes.results.common.PersonDetailsForm
 import com.example.nav3recipes.results.common.PersonDetailsScreen
 
-/**
- * This recipe demonstrates passing an event result to a previous screen. It does this by:
- *
- * - Providing a [ResultEventBus]
- * - Implementing a [ResultEffect] in the receiving screen
- * - Calling [ResultEventBus.sendResult] from the sending screen.
- */
 class ResultEventActivity : ComponentActivity() {
 
     override fun onCreate(savedInstanceState: Bundle?) {
diff --git a/app/src/main/java/com/example/nav3recipes/results/state/ResultStateActivity.kt b/app/src/main/java/com/example/nav3recipes/results/state/ResultStateActivity.kt
@@ -34,13 +34,6 @@ import com.example.nav3recipes.results.common.Person
 import com.example.nav3recipes.results.common.PersonDetailsForm
 import com.example.nav3recipes.results.common.PersonDetailsScreen
 
-/**
- * This recipe demonstrates passing an state result to a previous screen. It does this by:
- *
- * - Providing a [ResultStore]
- * - Calling [ResultStore.getResultState] in the receiving screen
- * - Calling [ResultStore.setResult] from the sending screen.
- */
 class ResultStateActivity : ComponentActivity() {
 
     override fun onCreate(savedInstanceState: Bundle?) {
diff --git a/app/src/main/java/com/example/nav3recipes/scenes/twopane/README.md b/app/src/main/java/com/example/nav3recipes/scenes/twopane/README.md
@@ -0,0 +1,10 @@
+# Two-Pane Scene Recipe
+
+This example shows how to create a two pane layout using the Scenes API.
+
+A `TwoPaneSceneStrategy` will return a `TwoPaneScene` if:
+
+-   the window width is over 600dp
+-   the last two nav entries on the back stack have indicated that they support being displayed in a `TwoPaneScene` in their metadata.
+
+See `TwoPaneScene.kt` for more implementation details.
diff --git a/app/src/main/java/com/example/nav3recipes/scenes/twopane/TwoPaneActivity.kt b/app/src/main/java/com/example/nav3recipes/scenes/twopane/TwoPaneActivity.kt
@@ -37,18 +37,6 @@ import com.example.nav3recipes.ui.setEdgeToEdgeConfig
 import com.example.nav3recipes.ui.theme.colors
 import kotlinx.serialization.Serializable
 
-/**
- * This example shows how to create custom layouts using the Scenes API.
- *
- * A custom Scene, `TwoPaneScene`, will render content in two panes if:
- *
- * - the window width is over 600dp
- * - the last two nav entries on the back stack have indicated that they support being displayed in
- * a `TwoPaneScene` in their metadata.
- *
- *
- * @see `TwoPaneScene`
- */
 @Serializable
 private object Home : NavKey
 
