From 828be405e11dd8bc7f8a3692d2c74517734f67a5 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sun, 30 Aug 2020 22:53:19 -0400 Subject: use inheritdoc --- src/SMAPI/Patches/DialogueErrorPatch.cs | 6 +++--- src/SMAPI/Patches/EventErrorPatch.cs | 5 ++--- src/SMAPI/Patches/LoadContextPatch.cs | 5 ++--- src/SMAPI/Patches/LoadErrorPatch.cs | 5 ++--- src/SMAPI/Patches/ObjectErrorPatch.cs | 5 ++--- src/SMAPI/Patches/ScheduleErrorPatch.cs | 5 ++--- 6 files changed, 13 insertions(+), 18 deletions(-) (limited to 'src/SMAPI/Patches') 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 *********/ - /// A unique name for this patch. + /// public string Name => nameof(DialogueErrorPatch); @@ -50,8 +50,7 @@ namespace StardewModdingAPI.Patches } - /// Apply the Harmony patch. - /// The Harmony instance. + /// #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..8fa882d4 100644 --- a/src/SMAPI/Patches/EventErrorPatch.cs +++ b/src/SMAPI/Patches/EventErrorPatch.cs @@ -27,7 +27,7 @@ namespace StardewModdingAPI.Patches /********* ** Accessors *********/ - /// A unique name for this patch. + /// public string Name => nameof(EventErrorPatch); @@ -41,8 +41,7 @@ namespace StardewModdingAPI.Patches EventErrorPatch.MonitorForGame = monitorForGame; } - /// Apply the Harmony patch. - /// The Harmony instance. + /// #if HARMONY_2 public void Apply(Harmony harmony) { 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 *********/ - /// A unique name for this patch. + /// public string Name => nameof(LoadContextPatch); @@ -49,8 +49,7 @@ namespace StardewModdingAPI.Patches LoadContextPatch.OnStageChanged = onStageChanged; } - /// Apply the Harmony patch. - /// The Harmony instance. + /// #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 *********/ - /// A unique name for this patch. + /// public string Name => nameof(LoadErrorPatch); @@ -51,8 +51,7 @@ namespace StardewModdingAPI.Patches } - /// Apply the Harmony patch. - /// The Harmony instance. + /// #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 *********/ - /// A unique name for this patch. + /// public string Name => nameof(ObjectErrorPatch); /********* ** Public methods *********/ - /// Apply the Harmony patch. - /// The Harmony instance. + /// #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 *********/ - /// A unique name for this patch. + /// public string Name => nameof(ScheduleErrorPatch); @@ -43,8 +43,7 @@ namespace StardewModdingAPI.Patches ScheduleErrorPatch.MonitorForGame = monitorForGame; } - /// Apply the Harmony patch. - /// The Harmony instance. + /// #if HARMONY_2 public void Apply(Harmony harmony) #else -- cgit From d7209e438d926bad7ae027ac489937dd3b4d3f8c Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Sat, 5 Sep 2020 20:08:01 -0400 Subject: fix code docs --- src/SMAPI/Patches/EventErrorPatch.cs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'src/SMAPI/Patches') diff --git a/src/SMAPI/Patches/EventErrorPatch.cs b/src/SMAPI/Patches/EventErrorPatch.cs index 8fa882d4..46651387 100644 --- a/src/SMAPI/Patches/EventErrorPatch.cs +++ b/src/SMAPI/Patches/EventErrorPatch.cs @@ -11,7 +11,7 @@ using StardewValley; namespace StardewModdingAPI.Patches { - /// A Harmony patch for the constructor which intercepts invalid dialogue lines and logs an error instead of crashing. + /// A Harmony patch for which intercepts invalid preconditions and logs an error instead of crashing. /// Patch methods must be static for Harmony to work correctly. See the Harmony documentation before renaming patch arguments. [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.")] @@ -65,7 +65,7 @@ namespace StardewModdingAPI.Patches ** Private methods *********/ #if HARMONY_2 - /// The method to call instead of the GameLocation.CheckEventPrecondition. + /// The method to call instead of GameLocation.checkEventPrecondition. /// The return value of the original method. /// The precondition to be parsed. /// The exception thrown by the wrapped method, if any. @@ -81,7 +81,7 @@ namespace StardewModdingAPI.Patches return null; } #else - /// The method to call instead of the GameLocation.CheckEventPrecondition. + /// The method to call instead of GameLocation.checkEventPrecondition. /// The instance being patched. /// The return value of the original method. /// The precondition to be parsed. -- cgit