diff options
| author | Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com> | 2020-09-07 13:06:27 -0400 |
|---|---|---|
| committer | Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com> | 2020-09-07 13:06:27 -0400 |
| commit | 5e43bdbf5cd6dbab36c25287c85d42ccfeea2c83 (patch) | |
| tree | 0a42305174eb84561a584549cd685c5e95670f36 /src/SMAPI/Patches/EventErrorPatch.cs | |
| parent | 8da88b8fe5b41739c5cd0df3280b9770fc7f10a4 (diff) | |
| parent | f9fac11028354f15d786d5b854608edb10716f79 (diff) | |
| download | SMAPI-5e43bdbf5cd6dbab36c25287c85d42ccfeea2c83.tar.gz SMAPI-5e43bdbf5cd6dbab36c25287c85d42ccfeea2c83.tar.bz2 SMAPI-5e43bdbf5cd6dbab36c25287c85d42ccfeea2c83.zip | |
Merge branch 'develop' into stable
Diffstat (limited to 'src/SMAPI/Patches/EventErrorPatch.cs')
| -rw-r--r-- | src/SMAPI/Patches/EventErrorPatch.cs | 11 |
1 files changed, 5 insertions, 6 deletions
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> |