From 1f3e21ce19618059dfd751c1bd2d4b53bde9fb4d Mon Sep 17 00:00:00 2001
From: XtraCube <72575280+XtraCube@users.noreply.github.com>
Date: Sun, 18 May 2025 10:01:48 -0400
Subject: [PATCH] cleanup more warnings

---
 MiraAPI/GameOptions/IModdedOption.cs        | 58 +++++++++++++++++++++
 MiraAPI/GameOptions/ModdedOptionsManager.cs |  2 +
 MiraAPI/Patches/.editorconfig               |  5 ++
 MiraAPI/Roles/ModdedRoleTeams.cs            | 14 +++++
 MiraAPI/Roles/RoleId.cs                     | 17 +++++-
 MiraAPI/Utilities/MiraNumberSuffixes.cs     | 19 +++++++
 6 files changed, 114 insertions(+), 1 deletion(-)
 create mode 100644 MiraAPI/Patches/.editorconfig

diff --git a/MiraAPI/GameOptions/IModdedOption.cs b/MiraAPI/GameOptions/IModdedOption.cs
index f40f3cf..86baf9d 100644
--- a/MiraAPI/GameOptions/IModdedOption.cs
+++ b/MiraAPI/GameOptions/IModdedOption.cs
@@ -6,18 +6,76 @@ using UnityEngine;
 
 namespace MiraAPI.GameOptions;
 
+/// <summary>
+/// Interface for modded options.
+/// </summary>
 public interface IModdedOption
 {
+    /// <summary>
+    /// Gets the unique identifier for the option.
+    /// </summary>
     uint Id { get; }
+
+    /// <summary>
+    /// Gets the title of the option.
+    /// </summary>
     string Title { get; }
+
+    /// <summary>
+    /// Gets the StringName for the option, used for localization.
+    /// </summary>
     StringNames StringName { get; }
+
+    /// <summary>
+    /// Gets or sets the MiraPlugin that created this option.
+    /// </summary>
     IMiraPlugin? ParentMod { get; set; }
+
+    /// <summary>
+    /// Gets the game setting data for the option.
+    /// </summary>
     BaseGameSetting Data { get; }
+
+    /// <summary>
+    /// Gets the OptionBehaviour object of the option.
+    /// </summary>
     OptionBehaviour? OptionBehaviour { get; }
+
+    /// <summary>
+    /// Gets or sets the visibility function for the option.
+    /// </summary>
     Func<bool> Visible { get; set; }
+
+    /// <summary>
+    /// Gets or sets the ConfigDefinition for the option, used for BepInEx configuration.
+    /// </summary>
     ConfigDefinition? ConfigDefinition { get; set; }
+
+    /// <summary>
+    /// Creates the option behaviour for the modded option.
+    /// </summary>
+    /// <param name="toggleOpt">The ToggleOption template.</param>
+    /// <param name="numberOpt">The NumberOption template.</param>
+    /// <param name="stringOpt">The StringOption template.</param>
+    /// <param name="container">>The Transform container for the option.</param>
+    /// <returns>>The created OptionBehaviour object.</returns>
     OptionBehaviour CreateOption(ToggleOption toggleOpt, NumberOption numberOpt, StringOption stringOpt, Transform container);
+
+    /// <summary>
+    /// Gets the value as a float.
+    /// </summary>
+    /// <returns>>The value of the option as a float.</returns>
     float GetFloatData();
+
+    /// <summary>
+    /// Gets the NetData for the option, used for network synchronization.
+    /// </summary>
+    /// <returns>>Returns the NetData object for the option.</returns>
     NetData GetNetData();
+
+    /// <summary>
+    /// Handles incoming network data for the option.
+    /// </summary>
+    /// <param name="data">>The byte array representing the network data.</param>
     void HandleNetData(byte[] data);
 }
diff --git a/MiraAPI/GameOptions/ModdedOptionsManager.cs b/MiraAPI/GameOptions/ModdedOptionsManager.cs
index c3e7e22..4d28884 100644
--- a/MiraAPI/GameOptions/ModdedOptionsManager.cs
+++ b/MiraAPI/GameOptions/ModdedOptionsManager.cs
@@ -175,6 +175,7 @@ public static class ModdedOptionsManager
     /// </summary>
     /// <param name="__originalMethod">The original setter method.</param>
     /// <param name="value">The new object value.</param>
+    // ReSharper disable InconsistentNaming
     public static void PropertySetterPatch(MethodBase __originalMethod, object value)
     {
         var attribute = OptionAttributes.First(pair => pair.Key.GetSetMethod() == __originalMethod).Value;
@@ -188,6 +189,7 @@ public static class ModdedOptionsManager
     /// <param name="__result">The result of the property getter.</param>
     /// <returns>False so the original getter gets skipped.</returns>
     public static bool PropertyGetterPatch(MethodBase __originalMethod, ref object __result)
+    // ReSharper restore InconsistentNaming
     {
         var attribute = OptionAttributes.First(pair => pair.Key.GetGetMethod() == __originalMethod).Value;
         __result = attribute.GetValue();
diff --git a/MiraAPI/Patches/.editorconfig b/MiraAPI/Patches/.editorconfig
new file mode 100644
index 0000000..1afcd96
--- /dev/null
+++ b/MiraAPI/Patches/.editorconfig
@@ -0,0 +1,5 @@
+[*.{cs,vb}]
+dotnet_diagnostic.CA1707.severity = none
+dotnet_diagnostic.CS1591.severity = none
+dotnet_diagnostic.SA1611.severity = none
+dotnet_diagnostic.SA1615.severity = none
\ No newline at end of file
diff --git a/MiraAPI/Roles/ModdedRoleTeams.cs b/MiraAPI/Roles/ModdedRoleTeams.cs
index 0d8c6a1..8661060 100644
--- a/MiraAPI/Roles/ModdedRoleTeams.cs
+++ b/MiraAPI/Roles/ModdedRoleTeams.cs
@@ -1,8 +1,22 @@
 namespace MiraAPI.Roles;
 
+/// <summary>
+/// Enum for modded role teams.
+/// </summary>
 public enum ModdedRoleTeams
 {
+    /// <summary>
+    /// The crewmate team.
+    /// </summary>
     Crewmate,
+
+    /// <summary>
+    /// The impostor team.
+    /// </summary>
     Impostor,
+
+    /// <summary>
+    /// Custom team, catchall for any other teams.
+    /// </summary>
     Custom,
 }
diff --git a/MiraAPI/Roles/RoleId.cs b/MiraAPI/Roles/RoleId.cs
index 05f9cd0..91044fb 100644
--- a/MiraAPI/Roles/RoleId.cs
+++ b/MiraAPI/Roles/RoleId.cs
@@ -2,9 +2,18 @@
 
 namespace MiraAPI.Roles;
 
+/// <summary>
+/// Utility class to get the ID of a role.
+/// </summary>
 public static class RoleId
 {
-    public static ushort Get<T>() where T : RoleBehaviour
+    /// <summary>
+    /// Gets the ID of a role.
+    /// </summary>
+    /// <typeparam name="T">The type of the role.</typeparam>
+    /// <returns>The role ID as a ushort.</returns>
+    /// <exception cref="InvalidOperationException">Thrown when the role is not registered.</exception>
+    public static ushort Get<T>() where T : ICustomRole
     {
         if (!CustomRoleManager.RoleIds.TryGetValue(typeof(T), out var roleId))
         {
@@ -14,6 +23,12 @@ public static class RoleId
         return roleId;
     }
 
+    /// <summary>
+    /// Gets the ID of a role.
+    /// </summary>
+    /// <param name="type">The type of the role.</param>
+    /// <returns>The ID as a ushort.</returns>
+    /// <exception cref="InvalidOperationException">Thrown when the role is not registered.</exception>
     public static ushort Get(Type type)
     {
         if (!CustomRoleManager.RoleIds.TryGetValue(type, out var roleId))
diff --git a/MiraAPI/Utilities/MiraNumberSuffixes.cs b/MiraAPI/Utilities/MiraNumberSuffixes.cs
index 20ed21c..2f55226 100644
--- a/MiraAPI/Utilities/MiraNumberSuffixes.cs
+++ b/MiraAPI/Utilities/MiraNumberSuffixes.cs
@@ -1,8 +1,27 @@
 namespace MiraAPI.Utilities;
+
+/// <summary>
+/// Suffixes used for options numbers.
+/// </summary>
 public enum MiraNumberSuffixes
 {
+    /// <summary>
+    /// No suffix.
+    /// </summary>
     None,
+
+    /// <summary>
+    /// Multiplier suffix (x).
+    /// </summary>
     Multiplier,
+
+    /// <summary>
+    /// Seconds suffix (s).
+    /// </summary>
     Seconds,
+
+    /// <summary>
+    /// Percentage suffix (%).
+    /// </summary>
     Percent,
 }