From 776e020faba8d45f5086ca9798b21d4c0bc809ae Mon Sep 17 00:00:00 2001 From: Kristen McWilliam <9575627+Merrit@users.noreply.github.com> Date: Tue, 31 Jan 2023 11:06:13 -0500 Subject: [PATCH] docs(AppWindow): add doc comments --- lib/window/app_window.dart | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/lib/window/app_window.dart b/lib/window/app_window.dart index 1d329cce..1ce7026b 100644 --- a/lib/window/app_window.dart +++ b/lib/window/app_window.dart @@ -9,6 +9,7 @@ import '../logs/logs.dart'; import '../settings/settings.dart'; import '../storage/storage_repository.dart'; +/// Represents the main window of the app. class AppWindow { final StorageRepository _storage; @@ -40,13 +41,16 @@ class AppWindow { await windowManager.setPreventClose(shouldPreventClose); } + /// Closes the app. void close() => exit(0); + /// Hides the app window. Future hide() async { await saveWindowSize(); await windowManager.hide(); } + /// Shows the app window. Future show() async { final Rect? savedWindowSize = await getSavedWindowSize(); if (savedWindowSize != null) windowManager.setBounds(savedWindowSize);