Added some documentation to some stuff

This commit is contained in:
Lucas Nicodemus 2012-05-26 11:04:36 -06:00
parent 8ecabb7f2e
commit 1fb554a804
2 changed files with 32 additions and 1 deletions

View file

@ -180,6 +180,11 @@ namespace TShockAPI
restapi = "api";
}
/// <summary>
/// Lists all commands associated with a given permission
/// </summary>
/// <param name="perm">string permission - the permission to get information on</param>
/// <returns>List of commands</returns>
private static List<Command> GetCommands(string perm)
{
if (Commands.ChatCommands.Count < 1)
@ -187,6 +192,9 @@ namespace TShockAPI
return Commands.ChatCommands.Where(c => c.Permission == perm).ToList();
}
/// <summary>
/// Dumps the descriptions of each permission to a file in Markdown format.
/// </summary>
public static void DumpDescriptions()
{
var sb = new StringBuilder();