From a477101153cdfe8abb3771f15808771322ebc896 Mon Sep 17 00:00:00 2001
From: ialokim <ialokim@mailbox.org>
Date: Sat, 27 Nov 2021 22:03:38 +0100
Subject: [PATCH] add some KDoc to convenience functions
---
.../briarproject/briar/desktop/viewmodel/ComposeUtils.kt | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/src/main/kotlin/org/briarproject/briar/desktop/viewmodel/ComposeUtils.kt b/src/main/kotlin/org/briarproject/briar/desktop/viewmodel/ComposeUtils.kt
index 16e4abea0a..8c1d5be8e7 100644
--- a/src/main/kotlin/org/briarproject/briar/desktop/viewmodel/ComposeUtils.kt
+++ b/src/main/kotlin/org/briarproject/briar/desktop/viewmodel/ComposeUtils.kt
@@ -68,6 +68,12 @@ fun <VM : ViewModel> viewModel(
return viewModel
}
+/**
+ * Returns this [MutableState] as an immutable [State].
+ */
fun <T> MutableState<T>.asState(): State<T> = this
+/**
+ * Returns this [SnapshotStateList] as an immutable [List].
+ */
fun <T> SnapshotStateList<T>.asList(): List<T> = this
--
GitLab