Updated documentation
This commit is contained in:
@@ -5,10 +5,28 @@ namespace PluginManager.Others.Exceptions
|
||||
[Serializable]
|
||||
public class APIException : Exception
|
||||
{
|
||||
/// <summary>
|
||||
/// The function where the error occurred
|
||||
/// </summary>
|
||||
public string? Function { get; } = "not specified";
|
||||
|
||||
/// <summary>
|
||||
/// The error code
|
||||
/// </summary>
|
||||
public Error? ErrorCode { get; } = Error.UNKNOWN_ERROR;
|
||||
|
||||
/// <summary>
|
||||
/// The possible cause that determined the error
|
||||
/// </summary>
|
||||
public string? PossibleCause { get; } = "not specified";
|
||||
|
||||
/// <summary>
|
||||
/// The APIException contructor
|
||||
/// </summary>
|
||||
/// <param name="message">The error message</param>
|
||||
/// <param name="function">The function where the message was triggered</param>
|
||||
/// <param name="possible_cause">The possible cause of the error</param>
|
||||
/// <param name="error">The error code</param>
|
||||
public APIException(string message, string? function, string possible_cause, Error error) : base(message)
|
||||
{
|
||||
ErrorCode = error;
|
||||
@@ -16,22 +34,37 @@ namespace PluginManager.Others.Exceptions
|
||||
PossibleCause = possible_cause;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The APIException contructor
|
||||
/// </summary>
|
||||
/// <param name="message">The error message</param>
|
||||
/// <param name="function">The function where the message was triggered</param>
|
||||
/// <param name="errorCode">The error code</param>
|
||||
public APIException(string message, string? function, Error? errorCode) : base(message)
|
||||
{
|
||||
ErrorCode = errorCode;
|
||||
Function = function;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The APIException contructor
|
||||
/// </summary>
|
||||
/// <param name="message">The error message</param>
|
||||
/// <param name="function">The function where the message was triggered</param>
|
||||
public APIException(string message, string? function) : base(message)
|
||||
{
|
||||
Function = function;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The APIException contructor
|
||||
/// </summary>
|
||||
/// <param name="message">The error message</param>
|
||||
public APIException(string message) : base(message)
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Method to print the error to <see cref="Console"/>
|
||||
/// </summary>
|
||||
public void Print()
|
||||
{
|
||||
Console.WriteLine("Message Content: " + Message);
|
||||
|
||||
Reference in New Issue
Block a user