Browse Source

Rename Synopsis to Summary to improve clarity

pull/178/head
Finite Reality 9 years ago
parent
commit
86092f9253
3 changed files with 10 additions and 10 deletions
  1. +2
    -2
      src/Discord.Net.Commands/Attributes/DescriptionAttribute.cs
  2. +4
    -4
      src/Discord.Net.Commands/Command.cs
  3. +4
    -4
      src/Discord.Net.Commands/Module.cs

+ 2
- 2
src/Discord.Net.Commands/Attributes/DescriptionAttribute.cs View File

@@ -15,10 +15,10 @@ namespace Discord.Commands

// Brief summary of method/module/parameter
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class | AttributeTargets.Parameter)]
public class SynopsisAttribute : Attribute
public class SummaryAttribute : Attribute
{
public string Text { get; }
public SynopsisAttribute(string text)
public SummaryAttribute(string text)
{
Text = text;
}


+ 4
- 4
src/Discord.Net.Commands/Command.cs View File

@@ -15,7 +15,7 @@ namespace Discord.Commands

public string Name { get; }
public string Description { get; }
public string Synopsis { get; }
public string Summary { get; }
public string Text { get; }
public Module Module { get; }
public IReadOnlyList<CommandParameter> Parameters { get; }
@@ -32,9 +32,9 @@ namespace Discord.Commands
if (description != null)
Description = description.Text;

var synopsis = methodInfo.GetCustomAttribute<SynopsisAttribute>();
if (synopsis != null)
Synopsis = synopsis.Text;
var summary = methodInfo.GetCustomAttribute<SummaryAttribute>();
if (summary != null)
Summary = summary.Text;

Parameters = BuildParameters(methodInfo);
_action = BuildAction(methodInfo);


+ 4
- 4
src/Discord.Net.Commands/Module.cs View File

@@ -9,7 +9,7 @@ namespace Discord.Commands
{
public CommandService Service { get; }
public string Name { get; }
public string Synopsis { get; }
public string Summary { get; }
public string Description { get; }
public IEnumerable<Command> Commands { get; }
internal object Instance { get; }
@@ -20,9 +20,9 @@ namespace Discord.Commands
Name = typeInfo.Name;
Instance = instance;

var synopsisAttr = typeInfo.GetCustomAttribute<SynopsisAttribute>();
if (synopsisAttr != null)
Synopsis = synopsisAttr.Text;
var summaryAttr = typeInfo.GetCustomAttribute<SummaryAttribute>();
if (summaryAttr != null)
Summary = summaryAttr.Text;

var descriptionAttr = typeInfo.GetCustomAttribute<DescriptionAttribute>();
if (descriptionAttr != null)


Loading…
Cancel
Save