From 83382617250feaa1b4002bdc151fa88cb3fd96dc Mon Sep 17 00:00:00 2001
From: Torsten Grote <t@grobox.de>
Date: Thu, 3 Aug 2023 09:33:28 +0200
Subject: [PATCH] Add docs explaining what SidebarViewModel#blogResetView is
 for

---
 .../briar/desktop/navigation/SidebarViewModel.kt            | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/briar-desktop/src/main/kotlin/org/briarproject/briar/desktop/navigation/SidebarViewModel.kt b/briar-desktop/src/main/kotlin/org/briarproject/briar/desktop/navigation/SidebarViewModel.kt
index 7146224e66..d236e61f78 100644
--- a/briar-desktop/src/main/kotlin/org/briarproject/briar/desktop/navigation/SidebarViewModel.kt
+++ b/briar-desktop/src/main/kotlin/org/briarproject/briar/desktop/navigation/SidebarViewModel.kt
@@ -86,6 +86,12 @@ constructor(
 
     val uiMode = _uiMode.asState()
     val account = _account.asState()
+
+    /**
+     * A random number that changes everytime, the user changes the [UiMode] with [setUiMode] to [UiMode.BLOGS].
+     * This can be useful to reset the blog screen to the main blog feed instead of showing an individual blog.
+     * When we have a proper navigation system in place, it can hopefully replace this hack.
+     */
     val blogResetView = _blogResetView.asState()
     val mailboxProblem = _mailboxProblem.asState()
 
-- 
GitLab