From 417ffbc7400216ce144dbc2b9904d4cfd65c9da5 Mon Sep 17 00:00:00 2001 From: Lucas Nicodemus Date: Sun, 12 Apr 2015 23:39:04 -0600 Subject: [PATCH] Updated XML documentation for several methods --- TShockAPI/DB/GroupManager.cs | 2 ++ TShockAPI/DB/UserManager.cs | 4 ++-- TShockAPI/Rest/Rest.cs | 3 +-- TShockAPI/Rest/RestObject.cs | 3 +-- TShockAPI/Rest/RestVerbs.cs | 3 +-- TShockAPI/TShock.cs | 3 +-- TShockAPI/Utils.cs | 18 +++++++++--------- 7 files changed, 17 insertions(+), 19 deletions(-) diff --git a/TShockAPI/DB/GroupManager.cs b/TShockAPI/DB/GroupManager.cs index 9e792615..40969354 100755 --- a/TShockAPI/DB/GroupManager.cs +++ b/TShockAPI/DB/GroupManager.cs @@ -210,6 +210,8 @@ namespace TShockAPI.DB /// parent of group /// permissions /// chatcolor + /// suffix + /// prefix //why is suffix before prefix?! public void UpdateGroup(string name, string parentname, string permissions, string chatcolor, string suffix, string prefix) { Group group = GetGroupByName(name); diff --git a/TShockAPI/DB/UserManager.cs b/TShockAPI/DB/UserManager.cs index c47d9f45..b58bca11 100755 --- a/TShockAPI/DB/UserManager.cs +++ b/TShockAPI/DB/UserManager.cs @@ -106,7 +106,7 @@ namespace TShockAPI.DB /// Sets the Hashed Password for a given username /// /// User user - /// string password + /// string password public void SetUserPassword(User user, string password) { try @@ -126,7 +126,7 @@ namespace TShockAPI.DB /// Sets the UUID for a given username /// /// User user - /// string uuid + /// string uuid public void SetUserUUID(User user, string uuid) { try diff --git a/TShockAPI/Rest/Rest.cs b/TShockAPI/Rest/Rest.cs index a5e77115..5de9d94f 100644 --- a/TShockAPI/Rest/Rest.cs +++ b/TShockAPI/Rest/Rest.cs @@ -34,8 +34,7 @@ namespace Rests /// /// Rest command delegate /// - /// Parameters in the url - /// {x} in urltemplate + /// RestRequestArgs object containing Verbs, Parameters, Request, and TokenData /// Response object or null to not handle request public delegate object RestCommandD(RestRequestArgs args); diff --git a/TShockAPI/Rest/RestObject.cs b/TShockAPI/Rest/RestObject.cs index 65503bec..edc70f58 100644 --- a/TShockAPI/Rest/RestObject.cs +++ b/TShockAPI/Rest/RestObject.cs @@ -57,8 +57,7 @@ namespace Rests /// /// Gets value safely, if it does not exist, return null. Sets/Adds value safely, if null it will remove. /// - /// - /// + /// the key /// Returns null if key does not exist. public new object this[string key] { diff --git a/TShockAPI/Rest/RestVerbs.cs b/TShockAPI/Rest/RestVerbs.cs index ab8c1500..fa18aec7 100644 --- a/TShockAPI/Rest/RestVerbs.cs +++ b/TShockAPI/Rest/RestVerbs.cs @@ -27,8 +27,7 @@ namespace Rests /// /// Gets value safely, if it does not exist, return null. Sets/Adds value safely, if null it will remove. /// - /// - /// + /// the key /// Returns null if key does not exist. public new string this[string key] { diff --git a/TShockAPI/TShock.cs b/TShockAPI/TShock.cs index 666207d0..9d6601f9 100755 --- a/TShockAPI/TShock.cs +++ b/TShockAPI/TShock.cs @@ -1123,8 +1123,7 @@ namespace TShockAPI /// /// When a server command is run. /// - /// - /// + /// The CommandEventArgs object private void ServerHooks_OnCommand(CommandEventArgs args) { if (args.Handled) diff --git a/TShockAPI/Utils.cs b/TShockAPI/Utils.cs index 2cc8bcc3..a8ea128d 100644 --- a/TShockAPI/Utils.cs +++ b/TShockAPI/Utils.cs @@ -472,7 +472,6 @@ namespace TShockAPI /// /// Kicks all player from the server without checking for immunetokick permission. /// - /// int player /// string reason public void ForceKickAll(string reason) { @@ -540,9 +539,10 @@ namespace TShockAPI /// /// Kicks a player from the server without checking for immunetokick permission. /// - /// int player + /// TSPlayer player /// string reason /// bool silent (default: false) + /// bool saveSSI (default: false) public void ForceKick(TSPlayer player, string reason, bool silent = false, bool saveSSI = false) { Kick(player, reason, true, silent, null, saveSSI); @@ -551,7 +551,7 @@ namespace TShockAPI /// /// Kicks a player from the server.. /// - /// int player + /// TSPlayer player /// string reason /// bool force (default: false) /// bool silent (default: false) @@ -585,10 +585,10 @@ namespace TShockAPI /// /// Bans and kicks a player from the server. /// - /// int player + /// TSPlayer player /// string reason /// bool force (default: false) - /// bool silent (default: null) + /// string adminUserName (default: null) public bool Ban(TSPlayer player, string reason, bool force = false, string adminUserName = null) { if (!player.ConnectionAlive) @@ -636,7 +636,7 @@ namespace TShockAPI /// /// Shows a file to the user. /// - /// TSPlayer player + /// TSPlayer player /// string filename reletave to savedir public void ShowFileToUser(TSPlayer player, string file) { @@ -674,7 +674,7 @@ namespace TShockAPI /// /// Returns a Group from the name of the group /// - /// string groupName + /// string groupName public Group GetGroup(string groupName) { //first attempt on cached groups @@ -760,7 +760,7 @@ namespace TShockAPI /// /// Returns a Sha256 string for a given string /// - /// bytes to hash + /// string to hash /// string sha256 public string HashPassword(string password) { @@ -801,7 +801,7 @@ namespace TShockAPI /// /// Attempts to parse a string as a timespan (_d_m_h_s). /// - /// The time string. + /// The time string. /// The seconds. /// Whether the string was parsed successfully. public bool TryParseTime(string str, out int seconds)