diff --git a/src/Discord.Net.Commands/Attributes/RemarksAttribute.cs b/src/Discord.Net.Commands/Attributes/DescriptionAttribute.cs similarity index 57% rename from src/Discord.Net.Commands/Attributes/RemarksAttribute.cs rename to src/Discord.Net.Commands/Attributes/DescriptionAttribute.cs index e5b0d2142..9940c40f3 100644 --- a/src/Discord.Net.Commands/Attributes/RemarksAttribute.cs +++ b/src/Discord.Net.Commands/Attributes/DescriptionAttribute.cs @@ -2,13 +2,13 @@ namespace Discord.Commands { - // Extension of the Cosmetic Summary, for Groups and Commands + // Full summary of method [AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)] - public class RemarksAttribute : Attribute + public class DescriptionAttribute : Attribute { public string Text { get; } - public RemarksAttribute(string text) + public DescriptionAttribute(string text) { Text = text; } diff --git a/src/Discord.Net.Commands/Attributes/SummaryAttribute.cs b/src/Discord.Net.Commands/Attributes/SummaryAttribute.cs index 06c75af42..b7a4e3d43 100644 --- a/src/Discord.Net.Commands/Attributes/SummaryAttribute.cs +++ b/src/Discord.Net.Commands/Attributes/SummaryAttribute.cs @@ -2,7 +2,7 @@ namespace Discord.Commands { - // Cosmetic Description for Groups, Commands, and Parameters + // Brief summary of method/module/parameter [AttributeUsage(AttributeTargets.Method | AttributeTargets.Class | AttributeTargets.Parameter)] public class SummaryAttribute : Attribute { diff --git a/src/Discord.Net.Commands/Command.cs b/src/Discord.Net.Commands/Command.cs index b191b5786..9df0bcc9d 100644 --- a/src/Discord.Net.Commands/Command.cs +++ b/src/Discord.Net.Commands/Command.cs @@ -21,8 +21,8 @@ namespace Discord.Commands public MethodInfo Source { get; } public Module Module { get; } public string Name { get; } + public string Description { get; } public string Summary { get; } - public string Remarks { get; } public string Text { get; } public bool HasVarArgs { get; } public IReadOnlyList Aliases { get; } @@ -62,14 +62,14 @@ namespace Discord.Commands if (nameAttr != null) Name = nameAttr.Text; + var description = source.GetCustomAttribute(); + if (description != null) + Description = description.Text; + var summary = source.GetCustomAttribute(); if (summary != null) Summary = summary.Text; - var remarksAttr = source.GetCustomAttribute(); - if (remarksAttr != null) - Remarks = remarksAttr.Text; - Parameters = BuildParameters(source); HasVarArgs = Parameters.Count > 0 ? Parameters[Parameters.Count - 1].IsMultiple : false; Preconditions = BuildPreconditions(source); diff --git a/src/Discord.Net.Commands/Module.cs b/src/Discord.Net.Commands/Module.cs index 9d61ca522..7b8113252 100644 --- a/src/Discord.Net.Commands/Module.cs +++ b/src/Discord.Net.Commands/Module.cs @@ -13,7 +13,7 @@ namespace Discord.Commands public string Name { get; } public string Prefix { get; } public string Summary { get; } - public string Remarks { get; } + public string Description { get; } public IEnumerable Commands { get; } internal object Instance { get; } @@ -35,9 +35,9 @@ namespace Discord.Commands if (summaryAttr != null) Summary = summaryAttr.Text; - var remarksAttr = source.GetCustomAttribute(); - if (remarksAttr != null) - Remarks = remarksAttr.Text; + var descriptionAttr = source.GetCustomAttribute(); + if (descriptionAttr != null) + Description = descriptionAttr.Text; List commands = new List(); SearchClass(source, instance, commands, Prefix, dependencyMap);