Added missing code documentation

This commit is contained in:
DarthAffe committed 2018-04-08 11:58:10 +02:00
1 parent bbbae7d75f
commit b471c0e192
40 files changed
+364 -19

No files matched your search

@@ -66,6 +66,9 @@ namespace RGB.NET.Devices.Corsair
/// <inheritdoc />
public IEnumerable<IRGBDevice> Devices { get; private set; }
/// <summary>
/// The <see cref="DeviceUpdateTrigger"/> used to trigger the updates for corsair devices.
/// </summary>
public DeviceUpdateTrigger UpdateTrigger { get; private set; }
private CorsairUpdateQueue _updateQueue;
@@ -29,6 +29,10 @@ namespace RGB.NET.Devices.Corsair
// ReSharper disable once MemberCanBePrivate.Global
protected Dictionary<CorsairLedId, Led> InternalLedMapping { get; } = new Dictionary<CorsairLedId, Led>();
/// <summary>
/// Gets or sets the update queue performing updates for this device.
/// </summary>
// ReSharper disable once MemberCanBePrivate.Global
protected CorsairUpdateQueue UpdateQueue { get; set; }
#endregion
@@ -6,10 +6,18 @@ using RGB.NET.Devices.Corsair.Native;
namespace RGB.NET.Devices.Corsair
{
/// <inheritdoc />
/// <summary>
/// Represents the update-queue performing updates for corsair devices.
/// </summary>
public class CorsairUpdateQueue : UpdateQueue
{
#region Constructors
/// <summary>
/// Initializes a new instance of the <see cref="CorsairUpdateQueue"/> class.
/// </summary>
/// <param name="updateTrigger">The update trigger used by this queue.</param>
public CorsairUpdateQueue(IDeviceUpdateTrigger updateTrigger)
: base(updateTrigger)
{ }