Updated XML documentation for several methods

This commit is contained in:
Lucas Nicodemus 2015-04-12 23:39:04 -06:00
parent 726576e3e0
commit 417ffbc740
7 changed files with 17 additions and 19 deletions

View file

@ -210,6 +210,8 @@ namespace TShockAPI.DB
/// <param name="parentname">parent of group</param> /// <param name="parentname">parent of group</param>
/// <param name="permissions">permissions</param> /// <param name="permissions">permissions</param>
/// <param name="chatcolor">chatcolor</param> /// <param name="chatcolor">chatcolor</param>
/// <param name="suffix">suffix</param>
/// <param name="prefix">prefix</param> //why is suffix before prefix?!
public void UpdateGroup(string name, string parentname, string permissions, string chatcolor, string suffix, string prefix) public void UpdateGroup(string name, string parentname, string permissions, string chatcolor, string suffix, string prefix)
{ {
Group group = GetGroupByName(name); Group group = GetGroupByName(name);

View file

@ -106,7 +106,7 @@ namespace TShockAPI.DB
/// Sets the Hashed Password for a given username /// Sets the Hashed Password for a given username
/// </summary> /// </summary>
/// <param name="user">User user</param> /// <param name="user">User user</param>
/// <param name="group">string password</param> /// <param name="password">string password</param>
public void SetUserPassword(User user, string password) public void SetUserPassword(User user, string password)
{ {
try try
@ -126,7 +126,7 @@ namespace TShockAPI.DB
/// Sets the UUID for a given username /// Sets the UUID for a given username
/// </summary> /// </summary>
/// <param name="user">User user</param> /// <param name="user">User user</param>
/// <param name="group">string uuid</param> /// <param name="uuid">string uuid</param>
public void SetUserUUID(User user, string uuid) public void SetUserUUID(User user, string uuid)
{ {
try try

View file

@ -34,8 +34,7 @@ namespace Rests
/// <summary> /// <summary>
/// Rest command delegate /// Rest command delegate
/// </summary> /// </summary>
/// <param name="parameters">Parameters in the url</param> /// <param name="args">RestRequestArgs object containing Verbs, Parameters, Request, and TokenData</param>
/// <param name="verbs">{x} in urltemplate</param>
/// <returns>Response object or null to not handle request</returns> /// <returns>Response object or null to not handle request</returns>
public delegate object RestCommandD(RestRequestArgs args); public delegate object RestCommandD(RestRequestArgs args);

View file

@ -57,8 +57,7 @@ namespace Rests
/// <summary> /// <summary>
/// Gets value safely, if it does not exist, return null. Sets/Adds value safely, if null it will remove. /// Gets value safely, if it does not exist, return null. Sets/Adds value safely, if null it will remove.
/// </summary> /// </summary>
/// <param name="key"></param> /// <param name="key">the key</param>
/// <param name="value"></param>
/// <returns>Returns null if key does not exist.</returns> /// <returns>Returns null if key does not exist.</returns>
public new object this[string key] public new object this[string key]
{ {

View file

@ -27,8 +27,7 @@ namespace Rests
/// <summary> /// <summary>
/// Gets value safely, if it does not exist, return null. Sets/Adds value safely, if null it will remove. /// Gets value safely, if it does not exist, return null. Sets/Adds value safely, if null it will remove.
/// </summary> /// </summary>
/// <param name="key"></param> /// <param name="key">the key</param>
/// <param name="value"></param>
/// <returns>Returns null if key does not exist.</returns> /// <returns>Returns null if key does not exist.</returns>
public new string this[string key] public new string this[string key]
{ {

View file

@ -1123,8 +1123,7 @@ namespace TShockAPI
/// <summary> /// <summary>
/// When a server command is run. /// When a server command is run.
/// </summary> /// </summary>
/// <param name="cmd"></param> /// <param name="args">The CommandEventArgs object</param>
/// <param name="e"></param>
private void ServerHooks_OnCommand(CommandEventArgs args) private void ServerHooks_OnCommand(CommandEventArgs args)
{ {
if (args.Handled) if (args.Handled)

View file

@ -472,7 +472,6 @@ namespace TShockAPI
/// <summary> /// <summary>
/// Kicks all player from the server without checking for immunetokick permission. /// Kicks all player from the server without checking for immunetokick permission.
/// </summary> /// </summary>
/// <param name="ply">int player</param>
/// <param name="reason">string reason</param> /// <param name="reason">string reason</param>
public void ForceKickAll(string reason) public void ForceKickAll(string reason)
{ {
@ -540,9 +539,10 @@ namespace TShockAPI
/// <summary> /// <summary>
/// Kicks a player from the server without checking for immunetokick permission. /// Kicks a player from the server without checking for immunetokick permission.
/// </summary> /// </summary>
/// <param name="ply">int player</param> /// <param name="player">TSPlayer player</param>
/// <param name="reason">string reason</param> /// <param name="reason">string reason</param>
/// <param name="silent">bool silent (default: false)</param> /// <param name="silent">bool silent (default: false)</param>
/// <param name="saveSSI">bool saveSSI (default: false)</param>
public void ForceKick(TSPlayer player, string reason, bool silent = false, bool saveSSI = false) public void ForceKick(TSPlayer player, string reason, bool silent = false, bool saveSSI = false)
{ {
Kick(player, reason, true, silent, null, saveSSI); Kick(player, reason, true, silent, null, saveSSI);
@ -551,7 +551,7 @@ namespace TShockAPI
/// <summary> /// <summary>
/// Kicks a player from the server.. /// Kicks a player from the server..
/// </summary> /// </summary>
/// <param name="ply">int player</param> /// <param name="player">TSPlayer player</param>
/// <param name="reason">string reason</param> /// <param name="reason">string reason</param>
/// <param name="force">bool force (default: false)</param> /// <param name="force">bool force (default: false)</param>
/// <param name="silent">bool silent (default: false)</param> /// <param name="silent">bool silent (default: false)</param>
@ -585,10 +585,10 @@ namespace TShockAPI
/// <summary> /// <summary>
/// Bans and kicks a player from the server. /// Bans and kicks a player from the server.
/// </summary> /// </summary>
/// <param name="ply">int player</param> /// <param name="player">TSPlayer player</param>
/// <param name="reason">string reason</param> /// <param name="reason">string reason</param>
/// <param name="force">bool force (default: false)</param> /// <param name="force">bool force (default: false)</param>
/// <param name="adminUserName">bool silent (default: null)</param> /// <param name="adminUserName">string adminUserName (default: null)</param>
public bool Ban(TSPlayer player, string reason, bool force = false, string adminUserName = null) public bool Ban(TSPlayer player, string reason, bool force = false, string adminUserName = null)
{ {
if (!player.ConnectionAlive) if (!player.ConnectionAlive)
@ -636,7 +636,7 @@ namespace TShockAPI
/// <summary> /// <summary>
/// Shows a file to the user. /// Shows a file to the user.
/// </summary> /// </summary>
/// <param name="ply">TSPlayer player</param> /// <param name="player">TSPlayer player</param>
/// <param name="file">string filename reletave to savedir</param> /// <param name="file">string filename reletave to savedir</param>
public void ShowFileToUser(TSPlayer player, string file) public void ShowFileToUser(TSPlayer player, string file)
{ {
@ -674,7 +674,7 @@ namespace TShockAPI
/// <summary> /// <summary>
/// Returns a Group from the name of the group /// Returns a Group from the name of the group
/// </summary> /// </summary>
/// <param name="ply">string groupName</param> /// <param name="groupName">string groupName</param>
public Group GetGroup(string groupName) public Group GetGroup(string groupName)
{ {
//first attempt on cached groups //first attempt on cached groups
@ -760,7 +760,7 @@ namespace TShockAPI
/// <summary> /// <summary>
/// Returns a Sha256 string for a given string /// Returns a Sha256 string for a given string
/// </summary> /// </summary>
/// <param name="bytes">bytes to hash</param> /// <param name="password">string to hash</param>
/// <returns>string sha256</returns> /// <returns>string sha256</returns>
public string HashPassword(string password) public string HashPassword(string password)
{ {
@ -801,7 +801,7 @@ namespace TShockAPI
/// <summary> /// <summary>
/// Attempts to parse a string as a timespan (_d_m_h_s). /// Attempts to parse a string as a timespan (_d_m_h_s).
/// </summary> /// </summary>
/// <param name="time">The time string.</param> /// <param name="string">The time string.</param>
/// <param name="seconds">The seconds.</param> /// <param name="seconds">The seconds.</param>
/// <returns>Whether the string was parsed successfully.</returns> /// <returns>Whether the string was parsed successfully.</returns>
public bool TryParseTime(string str, out int seconds) public bool TryParseTime(string str, out int seconds)