From aa5cb132477c75415de4b4a432305a0ba3206106 Mon Sep 17 00:00:00 2001 From: Arthri <41360489+Arthri@users.noreply.github.com> Date: Tue, 23 Nov 2021 17:12:49 +0800 Subject: [PATCH 1/3] Fix bad XML(no opening /// For use in an Emoji event. /// public class EmojiEventArgs : GetDataHandledEventArgs @@ -1968,6 +1969,7 @@ namespace TShockAPI return args.Handled; } + /// /// For use in a TileEntityDisplayDollItemSync event. /// public class DisplayDollItemSyncEventArgs : GetDataHandledEventArgs @@ -2026,6 +2028,7 @@ namespace TShockAPI return args.Handled; } + /// /// For use in an OnRequestTileEntityInteraction event. /// public class RequestTileEntityInteractionEventArgs : GetDataHandledEventArgs From 350d76c31586c468a0e59eba8df78f5f6ea34756 Mon Sep 17 00:00:00 2001 From: Arthri <41360489+Arthri@users.noreply.github.com> Date: Tue, 23 Nov 2021 17:13:02 +0800 Subject: [PATCH 2/3] Fix bad XML(unescaped ampersand) --- TShockAPI/TShock.cs | 4 ++-- TShockAPI/Utils.cs | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/TShockAPI/TShock.cs b/TShockAPI/TShock.cs index ae6b6e00..1634fe77 100644 --- a/TShockAPI/TShock.cs +++ b/TShockAPI/TShock.cs @@ -79,7 +79,7 @@ namespace TShockAPI /// Players - Contains all TSPlayer objects for accessing TSPlayers currently on the server public static TSPlayer[] Players = new TSPlayer[Main.maxPlayers]; - /// Bans - Static reference to the ban manager for accessing bans & related functions. + /// Bans - Static reference to the ban manager for accessing bans & related functions. public static BanManager Bans; /// Warps - Static reference to the warp manager for accessing the warp system. public static WarpManager Warps; @@ -148,7 +148,7 @@ namespace TShockAPI /// public static event Action Initialized; - /// Version - The version required by the TerrariaAPI to be passed back for checking & loading the plugin. + /// Version - The version required by the TerrariaAPI to be passed back for checking & loading the plugin. /// value - The version number specified in the Assembly, based on the VersionNum variable set in this class. public override Version Version { diff --git a/TShockAPI/Utils.cs b/TShockAPI/Utils.cs index 42f8ea96..96bbf3fb 100644 --- a/TShockAPI/Utils.cs +++ b/TShockAPI/Utils.cs @@ -894,7 +894,7 @@ namespace TShockAPI Main.recipe[i] = new Recipe(); } - /// Dumps a matrix of all permissions & all groups in Markdown table format. + /// Dumps a matrix of all permissions & all groups in Markdown table format. /// The save destination. internal void DumpPermissionMatrix(string path) { From c5eeae85909ef044af46f45119bc26d355be3f8a Mon Sep 17 00:00:00 2001 From: Arthri <41360489+Arthri@users.noreply.github.com> Date: Tue, 23 Nov 2021 17:23:44 +0800 Subject: [PATCH 3/3] Add changelog entry --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 46cd481e..ee4cda84 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,6 +15,7 @@ This is the rolling changelog for TShock for Terraria. Use past tense when addin ## Upcoming changes * Removed `TShockAPI/DB/DBTools.cs`. This appears to have been dead code and not used by anything. (@hakusaro, @DeathCradle) * Fixed the `/firework` command not sending fireworks when specified without a firework color. The firework command now correctly sends red fireworks to a target if a color is not specified. (@hakusaro, @Kojirremer) +* Fixed bad XML of TShock code documentation. (@Arthri) ## TShock 4.5.7 * Fixed the `/respawn` command to permit respawning players from the console. (@hakusaro, @Kojirremer)