Browse Source

Add CommandError xmldocs

pull/988/head
Hsu Still 7 years ago
parent
commit
c6d4494047
1 changed files with 25 additions and 1 deletions
  1. +25
    -1
      src/Discord.Net.Commands/CommandError.cs

+ 25
- 1
src/Discord.Net.Commands/CommandError.cs View File

@@ -1,26 +1,50 @@
namespace Discord.Commands
namespace Discord.Commands
{ {
public enum CommandError public enum CommandError
{ {
//Search //Search
/// <summary>
/// Thrown when the command is unknown.
/// </summary>
UnknownCommand = 1, UnknownCommand = 1,


//Parse //Parse
/// <summary>
/// Thrown when the command fails to be parsed.
/// </summary>
ParseFailed, ParseFailed,
/// <summary>
/// Thrown when the input text has too few parameters.
/// </summary>
BadArgCount, BadArgCount,


//Parse (Type Reader) //Parse (Type Reader)
//CastFailed, //CastFailed,
/// <summary>
/// Thrown when the object cannot be found by the <see cref="TypeReader"/>.
/// </summary>
ObjectNotFound, ObjectNotFound,
/// <summary>
/// Thrown when more than one objects is matched by <see cref="TypeReader"/>.
/// </summary>
MultipleMatches, MultipleMatches,


//Preconditions //Preconditions
/// <summary>
/// Thrown when the command fails to meet a <see cref="PreconditionAttribute"/>'s conditions.
/// </summary>
UnmetPrecondition, UnmetPrecondition,


//Execute //Execute
/// <summary>
/// Thrown when an exception occurs mid-command execution.
/// </summary>
Exception, Exception,


//Runtime //Runtime
/// <summary>
/// Thrown when the command is not successfully executed on runtime.
/// </summary>
Unsuccessful Unsuccessful
} }
} }

Loading…
Cancel
Save