Updated docstrings to reference classes, fields, and methods directly

This commit is contained in:
David Higueros committed 2026-06-23 20:43:32 -06:00
1 parent c846109d07
commit adb9a2823d
145 files changed
+941 -938

No files matched your search

@@ -15,13 +15,13 @@ using UnityEngine.UI;
namespace MiraAPI.Modifiers.ModifierDisplay;
/// <summary>
/// The code used to display Mira modifiers.
/// The code used to display <see cref="BaseModifier"/>s.
/// </summary>
[RegisterInIl2Cpp]
public class ModifierDisplayComponent(nint cppPtr) : MonoBehaviour(cppPtr)
{
/// <summary>
/// Gets the instance of the Modifier Display.
/// Gets the instance of the <see cref="ModifierDisplayComponent"/>.
/// </summary>
public static ModifierDisplayComponent? Instance { get; private set; }
@@ -41,7 +41,7 @@ public class ModifierDisplayComponent(nint cppPtr) : MonoBehaviour(cppPtr)
private readonly Dictionary<BaseModifier, ModifierUiComponent> _modifiers = [];
/// <summary>
/// Gets a read only dictionary of the created modifier UI components.
/// Gets a <see cref="ReadOnlyDictionary{TKey, TValue}"/> of the created <see cref="ModifierUiComponent"/>s.
/// </summary>
[HideFromIl2Cpp]
public ReadOnlyDictionary<BaseModifier, ModifierUiComponent> Modifiers => new(_modifiers);
@@ -108,7 +108,7 @@ public class ModifierDisplayComponent(nint cppPtr) : MonoBehaviour(cppPtr)
}
/// <summary>
/// Use this to refresh the modifiers UI. Useful if you hide modifiers uis based on options.
/// Use this to refresh the modifiers UI. Useful if you hide modifiers UIs based on options.
/// </summary>
public void RefreshModifiers()
{