From e74e2305edcf036af997095acb2afee443d05c71 Mon Sep 17 00:00:00 2001
From: Arkadii Ivanov <arkann1985@gmail.com>
Date: Fri, 10 Nov 2023 22:10:34 +0000
Subject: [PATCH] Added more docs for ChildStack

---
 .../com/arkivanov/decompose/router/stack/ChildStack.kt      | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/stack/ChildStack.kt b/decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/stack/ChildStack.kt
index d2313ed11..53c88f4c2 100644
--- a/decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/stack/ChildStack.kt
+++ b/decompose/src/commonMain/kotlin/com/arkivanov/decompose/router/stack/ChildStack.kt
@@ -5,12 +5,18 @@ import com.arkivanov.decompose.GettingList
 
 /**
  * A state holder for `Child Stack`.
+ *
+ * @param active the currently active (top) child of the stack.
+ * @param backStack the back stack (inactive children), can be empty.
  */
 data class ChildStack<out C : Any, out T : Any>(
     val active: Child.Created<C, T>,
     val backStack: List<Child.Created<C, T>> = emptyList(),
 ) {
 
+    /**
+     * Creates [ChildStack] with only one child with the specified [configuration] and [instance].
+     */
     constructor(configuration: C, instance: T) : this(
         active = Child.Created(
             configuration = configuration,