Added tons of xml-comments.

This commit is contained in:
DarthAffe committed 2015-10-17 16:57:50 +02:00
1 parent 57ad0f30e2
commit 6de1087c1f
23 files changed
+422 -51

No files matched your search

+10
View File
@@ -6,16 +6,26 @@ using CUE.NET.Devices.Generic.Enums;
namespace CUE.NET.Exceptions
{
/// <summary>
/// Represents an exception thrown by the CUE.
/// </summary>
public class CUEException : ApplicationException
{
#region Properties & Fields
/// <summary>
/// Gets the <see cref="CorsairError" /> provided by CUE.
/// </summary>
public CorsairError Error { get; }
#endregion
#region Constructors
/// <summary>
/// Initializes a new instance of the <see cref="CUEException"/> class.
/// </summary>
/// <param name="error">The <see cref="CorsairError" /> provided by CUE, which leads to this exception.</param>
public CUEException(CorsairError error)
{
this.Error = error;
+8
View File
@@ -2,10 +2,18 @@
namespace CUE.NET.Exceptions
{
/// <summary>
/// Represents an exception thrown by this SDK-Wrapper.
/// </summary>
public class WrapperException : ApplicationException
{
#region Constructors
/// <summary>
/// Initializes a new instance of the <see cref="WrapperException"/> class.
/// </summary>
/// <param name="message">The message which describes the reason of throwing this exception.</param>
/// <param name="innerException">Optional inner exception, which lead to this exception.</param>
public WrapperException(string message, Exception innerException = null)
: base(message, innerException)
{ }