Document gui-settings

1 files changed, 14 insertions, 0 deletions

diff --git a/gui/src/shared/gui-settings-state.ts b/gui/src/shared/gui-settings-state.ts
index c99ac10506..043892f833 100644
--- a/gui/src/shared/gui-settings-state.ts
+++ b/gui/src/shared/gui-settings-state.ts
@@ -1,9 +1,23 @@
+// This is a special value which is when contained within IGuiSettingsState.preferredLocale
+// indicates that app should use the active operating system locale to determine the UI language.
 export const SYSTEM_PREFERRED_LOCALE_KEY = 'system';
 
 export interface IGuiSettingsState {
+  // A user interface locale.
+  // Use 'system' to opt-in for active locale set in the operating system
+  // (see SYSTEM_PREFERRED_LOCALE_KEY)
   preferredLocale: string;
+
+  // Enable or disable system notifications on tunnel state etc.
   enableSystemNotifications: boolean;
+
+  // Tells the app to activate auto-connect feature in the mullvad-daemon, but only if the app is
+  // set to auto-start with the system.
   autoConnect: boolean;
+
+  // Tells the app to use monochromatic set of icons for tray.
   monochromaticIcon: boolean;
+
+  // Tells the app to hide the main window on start.
   startMinimized: boolean;
 }