Skip to content

Commit faf1149

Browse files
committed
Make BlinkClientException public and add documentation
The `BlinkClientException` class was updated to enhance its usability and clarity. Key changes include: - Changed class accessibility from `internal` to `public`. - Added XML documentation for the class, including summaries and remarks. - Documented all constructors with XML comments. - Added comments to clarify the purpose of each constructor.
1 parent 2fc547c commit faf1149

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

Sources/Blink/Exceptions/BlinkClientException.cs

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,44 @@
22

33
namespace Blink.Exceptions
44
{
5+
/// <summary>
6+
/// Represents errors that occur during Blink client operations.
7+
/// </summary>
8+
/// <remarks>This exception is typically thrown when an error specific to the Blink client occurs, such as
9+
/// invalid operations, unexpected responses, or other client-related issues. It can be used to differentiate Blink
10+
/// client errors from other exceptions.</remarks>
511
[Serializable]
6-
internal class BlinkClientException : Exception
12+
public class BlinkClientException : Exception
713
{
14+
/// <summary>
15+
/// Represents an exception that is specific to the BlinkClient application.
16+
/// </summary>
17+
/// <remarks>This exception is intended to be used for errors that occur within the BlinkClient
18+
/// application. It serves as a base exception for handling application-specific issues.</remarks>
819
public BlinkClientException()
920
{
21+
// Default constructor
1022
}
1123

24+
/// <summary>
25+
/// Initializes a new instance of the <see cref="BlinkClientException"/> class with a specified error message.
26+
/// </summary>
27+
/// <param name="message">The message that describes the error.</param>
1228
public BlinkClientException(string message) : base(message)
1329
{
30+
// Constructor with message
1431
}
1532

33+
/// <summary>
34+
/// Initializes a new instance of the <see cref="BlinkClientException"/> class with a specified error message
35+
/// and a reference to the inner exception that is the cause of this exception.
36+
/// </summary>
37+
/// <param name="message">The error message that explains the reason for the exception.</param>
38+
/// <param name="innerException">The exception that is the cause of the current exception, or <see langword="null"/> if no inner exception is
39+
/// specified.</param>
1640
public BlinkClientException(string message, Exception innerException) : base(message, innerException)
1741
{
42+
// Constructor with message and inner exception
1843
}
1944
}
2045
}

0 commit comments

Comments
 (0)