Updated PresenterFactory documentation

chRyNaN · Mar 25, 2022 · 7a6b13d · 7a6b13d
1 parent 99db779
commit 7a6b13d
Showing 1 changed file with 36 additions and 0 deletions.
diff --git a/presentation-core/src/commonMain/kotlin/com.chrynan.presentation/PresenterFactory.kt b/presentation-core/src/commonMain/kotlin/com.chrynan.presentation/PresenterFactory.kt
@@ -65,12 +65,48 @@ internal class PresenterFactoryDelegate<I : Intent, S : State, C : Change>(
         }
 }
 
+/**
+ * Creates a [PresenterFactory] delegate.
+ *
+ * Example usage:
+ *
+ * ```kotlin
+ * val presenter by presenterFactory { intents ->
+ *     Presenter(intents) {
+ *         this.view.intents()
+ *         .perform { intent, state -> ... }
+ *         .reduce { state, change -> ... }
+ *         .startWithInitialState()
+ *         .render()
+ *         .launchIn(coroutineScope)
+ *     }
+ * }
+ * ```
+ */
 fun <I : Intent, S : State, C : Change> presenterFactory(
     retainInstance: Boolean = true,
     factory: PresenterFactory<I, S, C>
 ): ReadOnlyProperty<View<I, S>, Presenter<I, S, C>> =
     PresenterFactoryDelegate(factory = factory, retainInstance = retainInstance)
 
+/**
+ * Creates a [PresenterFactory] delegate.
+ *
+ * Example usage:
+ *
+ * ```kotlin
+ * val presenter by presenterFactory { intents ->
+ *     Presenter(intents) {
+ *         this.view.intents()
+ *         .perform { intent, state -> ... }
+ *         .reduce { state, change -> ... }
+ *         .startWithInitialState()
+ *         .render()
+ *         .launchIn(coroutineScope)
+ *     }
+ * }
+ * ```
+ */
 fun <I : Intent, S : State, C : Change> presenterFactory(
     retainInstance: Boolean = true,
     factory: (intents: Flow<I>) -> Presenter<I, S, C>