diff options
Diffstat (limited to 'src/SMAPI/Framework/RewriteFacades/HarmonyInstanceMethods.cs')
-rw-r--r-- | src/SMAPI/Framework/RewriteFacades/HarmonyInstanceMethods.cs | 11 |
1 files changed, 3 insertions, 8 deletions
diff --git a/src/SMAPI/Framework/RewriteFacades/HarmonyInstanceMethods.cs b/src/SMAPI/Framework/RewriteFacades/HarmonyInstanceMethods.cs index bca76981..aad62c9b 100644 --- a/src/SMAPI/Framework/RewriteFacades/HarmonyInstanceMethods.cs +++ b/src/SMAPI/Framework/RewriteFacades/HarmonyInstanceMethods.cs @@ -1,5 +1,6 @@ using System; using System.Collections.Generic; +using System.Diagnostics.CodeAnalysis; using System.Linq; using System.Reflection; using System.Reflection.Emit; @@ -7,8 +8,9 @@ using HarmonyLib; namespace StardewModdingAPI.Framework.RewriteFacades { - /// <summary>Maps Harmony 1.x methods to Harmony 2.x to avoid breaking older mods.</summary> + /// <summary>Maps Harmony 1.x <code>HarmonyInstance</code> methods to Harmony 2.x's <see cref="Harmony"/> to avoid breaking older mods.</summary> /// <remarks>This is public to support SMAPI rewriting and should not be referenced directly by mods.</remarks> + [SuppressMessage("ReSharper", "CS1591", Justification = "Documentation not needed for facade classes.")] public class HarmonyInstanceMethods : Harmony { /********* @@ -19,18 +21,11 @@ namespace StardewModdingAPI.Framework.RewriteFacades public HarmonyInstanceMethods(string id) : base(id) { } - /// <summary>Creates a new Harmony instance.</summary> - /// <param name="id">A unique identifier for the instance.</param> public static Harmony Create(string id) { return new Harmony(id); } - /// <summary>Apply one or more patches to a method.</summary> - /// <param name="original">The original method.</param> - /// <param name="prefix">The prefix to apply.</param> - /// <param name="postfix">The postfix to apply.</param> - /// <param name="transpiler">The transpiler to apply.</param> public DynamicMethod Patch(MethodBase original, HarmonyMethod prefix = null, HarmonyMethod postfix = null, HarmonyMethod transpiler = null) { try |