Merge pull request #1580 from Pryaxis/warnings

Turn off compiler warnings for missing comments in permissions
This commit is contained in:
Chris 2017-12-24 01:41:28 +00:00 committed by GitHub
commit 0082b25533
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 15 deletions

View file

@ -23,8 +23,12 @@ using System.IO;
using System.Linq; using System.Linq;
using System.Text; using System.Text;
// Since the permission nodes have annotations that say what they are, we don't need XML comments.
#pragma warning disable 1591
namespace TShockAPI namespace TShockAPI
{ {
/// <summary>Contains the permission nodes used in TShock.</summary>
public static class Permissions public static class Permissions
{ {
// tshock.account nodes // tshock.account nodes
@ -400,6 +404,7 @@ namespace TShockAPI
[Description("Player can see advanced information about any user account.")] [Description("Player can see advanced information about any user account.")]
public static readonly string advaccountinfo = "tshock.accountinfo.details"; public static readonly string advaccountinfo = "tshock.accountinfo.details";
/// <summary> /// <summary>
/// Lists all commands associated with a given permission /// Lists all commands associated with a given permission
/// </summary> /// </summary>
@ -448,19 +453,4 @@ namespace TShockAPI
File.WriteAllText("PermissionsDescriptions.txt", sb.ToString()); File.WriteAllText("PermissionsDescriptions.txt", sb.ToString());
} }
} }
[AttributeUsage(AttributeTargets.Field, Inherited = false, AllowMultiple = false)]
public sealed class TodoAttribute : Attribute
{
public string Info { get; private set; }
public TodoAttribute(string info)
{
Info = info;
}
public TodoAttribute()
{
}
}
} }

View file

@ -18,8 +18,12 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
using System.ComponentModel; using System.ComponentModel;
// Since the permission nodes have annotations that say what they are, we don't need XML comments.
#pragma warning disable 1591
namespace Rests namespace Rests
{ {
/// <summary>Contains the REST permission nodes used in TShock.</summary>
public static class RestPermissions public static class RestPermissions
{ {
// tshock.rest.bans nodes // tshock.rest.bans nodes