From 23187117f971e5507fafabe4be77a20ee05230a6 Mon Sep 17 00:00:00 2001
From: Andrea Severi <andrea.severi.dev@gmail.com>
Date: Fri, 20 Dec 2024 00:07:55 +0100
Subject: [PATCH] Add doc for shouldFollowSystemTheme

---
 .../google/samples/apps/nowinandroid/MainActivityViewModel.kt  | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/app/src/main/kotlin/com/google/samples/apps/nowinandroid/MainActivityViewModel.kt b/app/src/main/kotlin/com/google/samples/apps/nowinandroid/MainActivityViewModel.kt
index ffc7e7696..35e4981fe 100644
--- a/app/src/main/kotlin/com/google/samples/apps/nowinandroid/MainActivityViewModel.kt
+++ b/app/src/main/kotlin/com/google/samples/apps/nowinandroid/MainActivityViewModel.kt
@@ -86,5 +86,8 @@ sealed interface MainActivityUiState {
      */
     fun shouldUseDarkTheme(isSystemDarkTheme: Boolean) = isSystemDarkTheme
 
+    /**
+     * Returns `true` if app theme should follow system theme.
+     */
     val shouldFollowSystemTheme: Boolean get() = true
 }