From 9854c9970a4550f0138da30fcd215f3bd7a5fed8 Mon Sep 17 00:00:00 2001
From: Matt Nadareski <mnadareski@outlook.com>
Date: Fri, 9 Apr 2021 13:31:23 -0700
Subject: [PATCH] Add descriptions to new options, change defaults

The default changes are:
- Setting `CompressLogFiles` to `true`
- Setting `ToolsInSeparateWindow` to `true`
- Setting `EnableLogFormatting` to `false`
- Setting `EnableProgressProcessing` to `false`

The last two don't really matter if `ToolsInSeparateWindow` is `true` since no UI-derived logs will ever trigger them, so they're being disabled for now.
---
 MPF.Library/Data/Options.cs | 28 +++++++++++++++++++++++-----
 1 file changed, 23 insertions(+), 5 deletions(-)

diff --git a/MPF.Library/Data/Options.cs b/MPF.Library/Data/Options.cs
index ed188427..93042e1d 100644
--- a/MPF.Library/Data/Options.cs
+++ b/MPF.Library/Data/Options.cs
@@ -273,7 +273,7 @@ namespace MPF.Data
         /// </summary>
         public bool ToolsInSeparateWindow
         {
-            get { return GetBooleanSetting(_settings, "ToolsInSeparateWindow", false); }
+            get { return GetBooleanSetting(_settings, "ToolsInSeparateWindow", true); }
             set { _settings["ToolsInSeparateWindow"] = value.ToString(); }
         }
 
@@ -291,7 +291,7 @@ namespace MPF.Data
         /// </summary>
         public bool CompressLogFiles
         {
-            get { return GetBooleanSetting(_settings, "CompressLogFiles", false); }
+            get { return GetBooleanSetting(_settings, "CompressLogFiles", true); }
             set { _settings["CompressLogFiles"] = value.ToString(); }
         }
 
@@ -321,27 +321,45 @@ namespace MPF.Data
 
         #region Logging Options
 
+        /// <summary>
+        /// Enable verbose and debug logs to be written
+        /// </summary>
         public bool VerboseLogging
         {
             get { return GetBooleanSetting(_settings, "VerboseLogging", true); }
             set { _settings["VerboseLogging"] = value.ToString(); }
         }
 
+        /// <summary>
+        /// Have the log panel expanded by default on startup
+        /// </summary>
         public bool OpenLogWindowAtStartup
         {
             get { return GetBooleanSetting(_settings, "OpenLogWindowAtStartup", true); }
             set { _settings["OpenLogWindowAtStartup"] = value.ToString(); }
         }
 
+        /// <summary>
+        /// Enable fancy formatting of log statements
+        /// Disables EnableProgressProcessing if disabled
+        /// </summary>
+        /// <remarks>
+        /// This is mainly for outputting redirected console outputs. Not many
+        /// other bits of the logs include any specially handled outputs.
+        /// </remarks>
         public bool EnableLogFormatting
         {
-            get { return GetBooleanSetting(_settings, "EnableFancyLog", true); }
-            set { _settings["EnableFancyLog"] = value.ToString(); }
+            get { return GetBooleanSetting(_settings, "EnableLogFormatting", false); }
+            set { _settings["EnableLogFormatting"] = value.ToString(); }
         }
 
+        /// <summary>
+        /// Enable progress bar updating based on log text
+        /// Disabled if EnableLogFormatting is disabled
+        /// </summary>
         public bool EnableProgressProcessing
         {
-            get { return GetBooleanSetting(_settings, "EnableProgressProcessing", true); }
+            get { return GetBooleanSetting(_settings, "EnableProgressProcessing", false); }
             set { _settings["EnableProgressProcessing"] = value.ToString(); }
         }