Skip to content

Commit c73ef7c

Browse files
committed
chore: trim doc comments to match codebase style
1 parent 3ea9c57 commit c73ef7c

2 files changed

Lines changed: 2 additions & 16 deletions

File tree

kotlin/src/main/kotlin/app/rive/RiveFile.kt

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -147,20 +147,8 @@ class RiveFile internal constructor(
147147
}
148148

149149
/**
150-
* Retrieves the default view model information for an artboard.
151-
*
152-
* View models define the data structure and bindings for an artboard. This method allows
153-
* discovery of which view model and instance are associated with the artboard by default,
154-
* as assigned in the Rive editor.
155-
*
156-
* This is useful when using [ViewModelSource.DefaultForArtboard] to create a view model
157-
* instance, since that path does not reveal the view model name. The name is required for
158-
* file-level queries like [getViewModelProperties] and [getViewModelInstanceNames].
159-
*
160150
* @param artboard The artboard to query for default view model information.
161151
* @return A [DefaultViewModelInfo] containing the view model name and instance name.
162-
* @throws RuntimeException If no default view model is found for the artboard.
163-
* @throws CancellationException If the coroutine is cancelled before the operation completes.
164152
*/
165153
suspend fun getDefaultViewModelInfo(artboard: Artboard): DefaultViewModelInfo =
166154
riveWorker.getDefaultViewModelInfo(fileHandle, artboard.artboardHandle)

kotlin/src/main/kotlin/app/rive/core/CommandQueue.kt

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2393,10 +2393,8 @@ value class FontHandle(val handle: Long) {
23932393
}
23942394

23952395
/**
2396-
* Information about the default view model for an artboard.
2397-
*
2398-
* Returned by [CommandQueue.getDefaultViewModelInfo]. Contains the name of the default view model
2399-
* and the name of its default instance, as assigned in the Rive editor.
2396+
* Information about the default view model for an artboard. Returned by
2397+
* [CommandQueue.getDefaultViewModelInfo].
24002398
*
24012399
* @param viewModelName The name of the default view model type for the artboard.
24022400
* @param instanceName The name of the default view model instance for the artboard.

0 commit comments

Comments
 (0)