Skip to content

Commit 12928cc

Browse files
committed
Fixes a few typos in ScreenViewFactory kdoc
1 parent 66d377d commit 12928cc

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

workflow-ui/core-android/src/main/java/com/squareup/workflow1/ui/ScreenViewFactory.kt

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public typealias ViewBindingInflater<BindingT> = (LayoutInflater, ViewGroup?, Bo
2121
* This is the interface you'll implement directly to update Android view code
2222
* from your [Screen] renderings. A [ScreenViewRunner] serves as the strategy
2323
* object of a [ScreenViewHolder] instantiated by a [ScreenViewFactory] -- the
24-
* runner provides the implmenetation for the holder's [ScreenViewHolder.show]
24+
* runner provides the implementation for the holder's [ScreenViewHolder.show]
2525
* method.
2626
*/
2727
@WorkflowUiExperimentalApi
@@ -142,7 +142,7 @@ public interface ScreenViewFactory<in ScreenT : Screen> : ViewRegistry.Entry<Scr
142142

143143
/**
144144
* Creates a [ScreenViewFactory] that builds [View] instances entirely from code,
145-
* using a [ScreenViewRunner] created by [constructor] to update it.
145+
* using a [ScreenViewRunner] created by [buildView] to update it.
146146
*/
147147
@WorkflowUiExperimentalApi
148148
public inline fun <reified ScreenT : Screen> fromCode(
@@ -174,11 +174,8 @@ public interface ScreenViewFactory<in ScreenT : Screen> : ViewRegistry.Entry<Scr
174174
* for you.
175175
*
176176
* Use the [ScreenViewFactoryFinder] in [environment] to return the [ScreenViewFactory]
177-
* bound to the type of the receiving [Screen].
178-
*
179-
* - Call [ScreenViewFactory.startShowing] to create and initialize a new [View]
180-
* - If you don't particularly need to mess with the [ScreenViewFactory] before creating
181-
* a view, use [Screen.startShowing] instead of this method.
177+
* bound to the type of the receiving [Screen]. Call [ScreenViewFactory.startShowing] to
178+
* create and initialize a new [View].
182179
*/
183180
@WorkflowUiExperimentalApi
184181
public fun <ScreenT : Screen> ScreenT.toViewFactory(
@@ -195,7 +192,8 @@ public fun <ScreenT : Screen> ScreenT.toViewFactory(
195192
* Creates a [ScreenViewHolder] wrapping a [View] able to display a stream
196193
* of [ScreenT] renderings, starting with [initialRendering].
197194
*
198-
* To add more initialization behavior (typically a call to [WorkflowLifecycleOwner.installOn]),
195+
* To add more initialization behavior (typically a call to
196+
* [WorkflowLifecycleOwner.installOn][com.squareup.workflow1.ui.androidx.WorkflowLifecycleOwner.installOn]),
199197
* provide a [viewStarter].
200198
*/
201199
@Suppress("DEPRECATION")

0 commit comments

Comments
 (0)