add documentation in mira assets

.editorconfig

@@ -1,6 +1 @@
-[*.{cs,vb}]
-dotnet_diagnostic.CA1707.severity = none
-dotnet_diagnostic.CS1591.severity = none
-dotnet_diagnostic.S125.severity = none
-dotnet_diagnostic.SA1615.severity = none
-dotnet_diagnostic.SA1611.severity = none
+[*.{cs,vb}]

MiraAPI/Utilities/Assets/MiraAssets.cs

@@ -3,18 +3,58 @@ using UnityEngine;
 
 namespace MiraAPI.Utilities.Assets;
 
+/// <summary>
+/// A static class that contains various assets used in the Mira API.
+/// </summary>
 public static class MiraAssets
 {
-    public static readonly AssetBundle MiraAssetBundle = AssetBundleManager.Load("mirabundle");
-    public static readonly LoadableAsset<GameObject> ModifierDisplay = new LoadableBundleAsset<GameObject>("Modifiers", MiraAssetBundle);
+    /// <summary>
+    /// Gets the color used for teal highlighting in UI.
+    /// </summary>
+    public static Color32 AcceptedTeal { get; } = new(43, 233, 198, 255);
 
-    public static readonly LoadableResourceAsset Empty = new("MiraAPI.Resources.Empty.png");
+    /// <summary>
+    /// Gets the Mira API asset bundle.
+    /// </summary>
+    public static AssetBundle MiraAssetBundle { get; } = AssetBundleManager.Load("mirabundle");
 
-    public static readonly LoadableResourceAsset NextButton = new("MiraAPI.Resources.NextButton.png");
-    public static readonly LoadableResourceAsset NextButtonActive = new("MiraAPI.Resources.NextButtonActive.png");
-    public static readonly LoadableResourceAsset Cog = new("MiraAPI.Resources.Cog.png");
-    public static readonly LoadableResourceAsset Checkmark = new("MiraAPI.Resources.Checkmark.png");
-    public static readonly LoadableResourceAsset CategoryHeader = new("MiraAPI.Resources.CategoryHeader.png");
-    public static readonly LoadableResourceAsset CheckmarkBox = new("MiraAPI.Resources.CheckMarkBox.png");
-    public static readonly Color32 AcceptedTeal = new(43, 233, 198, 255);
+    /// <summary>
+    /// Gets the ModifierDisplay prefab.
+    /// </summary>
+    public static LoadableAsset<GameObject> ModifierDisplay { get; } = new LoadableBundleAsset<GameObject>("Modifiers", MiraAssetBundle);
+
+    /// <summary>
+    /// Gets the empty sprite asset.
+    /// </summary>
+    public static LoadableResourceAsset Empty { get; } = new("MiraAPI.Resources.Empty.png");
+
+    /// <summary>
+    /// Gets the Next Button sprite.
+    /// </summary>
+    public static LoadableResourceAsset NextButton { get; } = new("MiraAPI.Resources.NextButton.png");
+
+    /// <summary>
+    /// Gets the highlighted Next Button sprite.
+    /// </summary>
+    public static LoadableResourceAsset NextButtonActive { get; } = new("MiraAPI.Resources.NextButtonActive.png");
+
+    /// <summary>
+    /// Gets the Cog icon used in Role Settings Menu.
+    /// </summary>
+    public static LoadableResourceAsset Cog { get; } = new("MiraAPI.Resources.Cog.png");
+
+    /// <summary>
+    /// Gets the Checkmark Box used in the Settings Menu.
+    /// </summary>
+    public static LoadableResourceAsset CheckmarkBox { get; } = new("MiraAPI.Resources.CheckMarkBox.png");
+
+    /// <summary>
+    /// Gets the Checkmark used in the Settings Menu.
+    /// </summary>
+    public static LoadableResourceAsset Checkmark { get; } = new("MiraAPI.Resources.Checkmark.png");
+
+    /// <summary>
+    /// Gets the white CategoryHeader used in the Settings Menu.
+    /// </summary>
+    public static LoadableResourceAsset CategoryHeader { get; } = new("MiraAPI.Resources.CategoryHeader.png");
 }