summaryrefslogtreecommitdiff
path: root/src/SMAPI/Patches
diff options
context:
space:
mode:
Diffstat (limited to 'src/SMAPI/Patches')
-rw-r--r--src/SMAPI/Patches/DialogueErrorPatch.cs6
-rw-r--r--src/SMAPI/Patches/EventErrorPatch.cs11
-rw-r--r--src/SMAPI/Patches/LoadContextPatch.cs5
-rw-r--r--src/SMAPI/Patches/LoadErrorPatch.cs5
-rw-r--r--src/SMAPI/Patches/ObjectErrorPatch.cs5
-rw-r--r--src/SMAPI/Patches/ScheduleErrorPatch.cs5
6 files changed, 16 insertions, 21 deletions
diff --git a/src/SMAPI/Patches/DialogueErrorPatch.cs b/src/SMAPI/Patches/DialogueErrorPatch.cs
index 8043eda3..42494390 100644
--- a/src/SMAPI/Patches/DialogueErrorPatch.cs
+++ b/src/SMAPI/Patches/DialogueErrorPatch.cs
@@ -33,7 +33,7 @@ namespace StardewModdingAPI.Patches
/*********
** Accessors
*********/
- /// <summary>A unique name for this patch.</summary>
+ /// <inheritdoc />
public string Name => nameof(DialogueErrorPatch);
@@ -50,8 +50,7 @@ namespace StardewModdingAPI.Patches
}
- /// <summary>Apply the Harmony patch.</summary>
- /// <param name="harmony">The Harmony instance.</param>
+ /// <inheritdoc />
#if HARMONY_2
public void Apply(Harmony harmony)
{
@@ -78,6 +77,7 @@ namespace StardewModdingAPI.Patches
}
#endif
+
/*********
** Private methods
*********/
diff --git a/src/SMAPI/Patches/EventErrorPatch.cs b/src/SMAPI/Patches/EventErrorPatch.cs
index 4dbb25f3..46651387 100644
--- a/src/SMAPI/Patches/EventErrorPatch.cs
+++ b/src/SMAPI/Patches/EventErrorPatch.cs
@@ -11,7 +11,7 @@ using StardewValley;
namespace StardewModdingAPI.Patches
{
- /// <summary>A Harmony patch for the <see cref="Dialogue"/> constructor which intercepts invalid dialogue lines and logs an error instead of crashing.</summary>
+ /// <summary>A Harmony patch for <see cref="GameLocation.checkEventPrecondition"/> which intercepts invalid preconditions and logs an error instead of crashing.</summary>
/// <remarks>Patch methods must be static for Harmony to work correctly. See the Harmony documentation before renaming patch arguments.</remarks>
[SuppressMessage("ReSharper", "InconsistentNaming", Justification = "Argument names are defined by Harmony and methods are named for clarity.")]
[SuppressMessage("ReSharper", "IdentifierTypo", Justification = "Argument names are defined by Harmony and methods are named for clarity.")]
@@ -27,7 +27,7 @@ namespace StardewModdingAPI.Patches
/*********
** Accessors
*********/
- /// <summary>A unique name for this patch.</summary>
+ /// <inheritdoc />
public string Name => nameof(EventErrorPatch);
@@ -41,8 +41,7 @@ namespace StardewModdingAPI.Patches
EventErrorPatch.MonitorForGame = monitorForGame;
}
- /// <summary>Apply the Harmony patch.</summary>
- /// <param name="harmony">The Harmony instance.</param>
+ /// <inheritdoc />
#if HARMONY_2
public void Apply(Harmony harmony)
{
@@ -66,7 +65,7 @@ namespace StardewModdingAPI.Patches
** Private methods
*********/
#if HARMONY_2
- /// <summary>The method to call instead of the GameLocation.CheckEventPrecondition.</summary>
+ /// <summary>The method to call instead of GameLocation.checkEventPrecondition.</summary>
/// <param name="__result">The return value of the original method.</param>
/// <param name="precondition">The precondition to be parsed.</param>
/// <param name="__exception">The exception thrown by the wrapped method, if any.</param>
@@ -82,7 +81,7 @@ namespace StardewModdingAPI.Patches
return null;
}
#else
- /// <summary>The method to call instead of the GameLocation.CheckEventPrecondition.</summary>
+ /// <summary>The method to call instead of GameLocation.checkEventPrecondition.</summary>
/// <param name="__instance">The instance being patched.</param>
/// <param name="__result">The return value of the original method.</param>
/// <param name="precondition">The precondition to be parsed.</param>
diff --git a/src/SMAPI/Patches/LoadContextPatch.cs b/src/SMAPI/Patches/LoadContextPatch.cs
index 768ddd6b..ceda061b 100644
--- a/src/SMAPI/Patches/LoadContextPatch.cs
+++ b/src/SMAPI/Patches/LoadContextPatch.cs
@@ -33,7 +33,7 @@ namespace StardewModdingAPI.Patches
/*********
** Accessors
*********/
- /// <summary>A unique name for this patch.</summary>
+ /// <inheritdoc />
public string Name => nameof(LoadContextPatch);
@@ -49,8 +49,7 @@ namespace StardewModdingAPI.Patches
LoadContextPatch.OnStageChanged = onStageChanged;
}
- /// <summary>Apply the Harmony patch.</summary>
- /// <param name="harmony">The Harmony instance.</param>
+ /// <inheritdoc />
#if HARMONY_2
public void Apply(Harmony harmony)
#else
diff --git a/src/SMAPI/Patches/LoadErrorPatch.cs b/src/SMAPI/Patches/LoadErrorPatch.cs
index 5e67b169..f5ee5d71 100644
--- a/src/SMAPI/Patches/LoadErrorPatch.cs
+++ b/src/SMAPI/Patches/LoadErrorPatch.cs
@@ -34,7 +34,7 @@ namespace StardewModdingAPI.Patches
/*********
** Accessors
*********/
- /// <summary>A unique name for this patch.</summary>
+ /// <inheritdoc />
public string Name => nameof(LoadErrorPatch);
@@ -51,8 +51,7 @@ namespace StardewModdingAPI.Patches
}
- /// <summary>Apply the Harmony patch.</summary>
- /// <param name="harmony">The Harmony instance.</param>
+ /// <inheritdoc />
#if HARMONY_2
public void Apply(Harmony harmony)
#else
diff --git a/src/SMAPI/Patches/ObjectErrorPatch.cs b/src/SMAPI/Patches/ObjectErrorPatch.cs
index 4edcc64e..64b8e6b6 100644
--- a/src/SMAPI/Patches/ObjectErrorPatch.cs
+++ b/src/SMAPI/Patches/ObjectErrorPatch.cs
@@ -23,15 +23,14 @@ namespace StardewModdingAPI.Patches
/*********
** Accessors
*********/
- /// <summary>A unique name for this patch.</summary>
+ /// <inheritdoc />
public string Name => nameof(ObjectErrorPatch);
/*********
** Public methods
*********/
- /// <summary>Apply the Harmony patch.</summary>
- /// <param name="harmony">The Harmony instance.</param>
+ /// <inheritdoc />
#if HARMONY_2
public void Apply(Harmony harmony)
#else
diff --git a/src/SMAPI/Patches/ScheduleErrorPatch.cs b/src/SMAPI/Patches/ScheduleErrorPatch.cs
index cc2238b0..17db07a6 100644
--- a/src/SMAPI/Patches/ScheduleErrorPatch.cs
+++ b/src/SMAPI/Patches/ScheduleErrorPatch.cs
@@ -29,7 +29,7 @@ namespace StardewModdingAPI.Patches
/*********
** Accessors
*********/
- /// <summary>A unique name for this patch.</summary>
+ /// <inheritdoc />
public string Name => nameof(ScheduleErrorPatch);
@@ -43,8 +43,7 @@ namespace StardewModdingAPI.Patches
ScheduleErrorPatch.MonitorForGame = monitorForGame;
}
- /// <summary>Apply the Harmony patch.</summary>
- /// <param name="harmony">The Harmony instance.</param>
+ /// <inheritdoc />
#if HARMONY_2
public void Apply(Harmony harmony)
#else
generated by cgit (git 2.46.0) at 2024-11-23 21:06:30 +0000