From afe56e412f8a75f2cb4f63c9d804d6e7f9cda2b1 Mon Sep 17 00:00:00 2001
From: goat <16760685+goaaats@users.noreply.github.com>
Date: Wed, 31 Mar 2021 15:49:15 +0200
Subject: [PATCH] refactor: new code style in DalamudStartInfo.cs

---
 Dalamud/ClientLanguage.cs   | 28 ++++++++++++++++++++++
 Dalamud/DalamudStartInfo.cs | 47 +++++++++++++++++++++++++++----------
 2 files changed, 62 insertions(+), 13 deletions(-)
 create mode 100644 Dalamud/ClientLanguage.cs

diff --git a/Dalamud/ClientLanguage.cs b/Dalamud/ClientLanguage.cs
new file mode 100644
index 000000000..ddd69576d
--- /dev/null
+++ b/Dalamud/ClientLanguage.cs
@@ -0,0 +1,28 @@
+namespace Dalamud
+{
+    /// <summary>
+    /// Enum describing the language the game loads in.
+    /// </summary>
+    public enum ClientLanguage
+    {
+        /// <summary>
+        /// Indicating a Japanese game client.
+        /// </summary>
+        Japanese,
+
+        /// <summary>
+        /// Indicating an English game client.
+        /// </summary>
+        English,
+
+        /// <summary>
+        /// Indicating a German game client.
+        /// </summary>
+        German,
+
+        /// <summary>
+        /// Indicating a French game client.
+        /// </summary>
+        French,
+    }
+}
diff --git a/Dalamud/DalamudStartInfo.cs b/Dalamud/DalamudStartInfo.cs
index 80b77d71c..89a57beb8 100644
--- a/Dalamud/DalamudStartInfo.cs
+++ b/Dalamud/DalamudStartInfo.cs
@@ -1,33 +1,54 @@
 using System;
-#pragma warning disable 1591
+#pragma warning disable SA1401 // Fields should be private
 
-namespace Dalamud {
+namespace Dalamud
+{
+    /// <summary>
+    /// Class containing information needed to initialize Dalamud.
+    /// </summary>
     [Serializable]
     public sealed class DalamudStartInfo
     {
+        /// <summary>
+        /// The working directory of the XIVLauncher installations.
+        /// </summary>
         public string WorkingDirectory;
+
+        /// <summary>
+        /// The path to the configuration file.
+        /// </summary>
         public string ConfigurationPath;
 
+        /// <summary>
+        /// The path to the directory for installed plugins.
+        /// </summary>
         public string PluginDirectory;
+
+        /// <summary>
+        /// The path to the directory for developer plugins.
+        /// </summary>
         public string DefaultPluginDirectory;
 
+        /// <summary>
+        /// The path to core Dalamud assets.
+        /// </summary>
         public string AssetDirectory;
 
+        /// <summary>
+        /// The language of the game client.
+        /// </summary>
         public ClientLanguage Language;
 
+        /// <summary>
+        /// The current game version code.
+        /// </summary>
         public string GameVersion;
 
+        /// <summary>
+        /// Whether or not market board information should be uploaded by default.
+        /// </summary>
         public bool OptOutMbCollection;
     }
-
-    /// <summary>
-    /// Enum describing the language the game loads in.
-    /// </summary>
-    public enum ClientLanguage
-    {
-        Japanese,
-        English,
-        German,
-        French
-    }
 }
+
+#pragma warning restore SA1401 // Fields should be private