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

@@ -63,6 +63,9 @@ namespace RGB.NET.Devices.CoolerMaster
// ReSharper disable once AutoPropertyCanBeMadeGetOnly.Global
public Func<CultureInfo> GetCulture { get; set; } = CultureHelper.GetCurrentCulture;
/// <summary>
/// The <see cref="DeviceUpdateTrigger"/> used to trigger the updates for cooler master devices.
/// </summary>
public DeviceUpdateTrigger UpdateTrigger { get; private set; }
#endregion
@@ -22,6 +22,10 @@ namespace RGB.NET.Devices.CoolerMaster
/// </summary>
public override TDeviceInfo DeviceInfo { get; }
/// <summary>
/// Gets or sets the update queue performing updates for this device.
/// </summary>
// ReSharper disable once MemberCanBePrivate.Global
protected CoolerMasterUpdateQueue UpdateQueue { get; set; }
#endregion
@@ -4,6 +4,10 @@ using RGB.NET.Devices.CoolerMaster.Native;
namespace RGB.NET.Devices.CoolerMaster
{
/// <inheritdoc />
/// <summary>
/// Represents the update-queue performing updates for cooler master devices.
/// </summary>
public class CoolerMasterUpdateQueue : UpdateQueue
{
#region Properties & Fields
@@ -14,6 +18,11 @@ namespace RGB.NET.Devices.CoolerMaster
#region Constructors
/// <summary>
/// Initializes a new instance of the <see cref="CoolerMasterUpdateQueue"/> class.
/// </summary>
/// <param name="updateTrigger">The update trigger used by this queue.</param>
/// <param name="deviceIndex">The <see cref="CoolerMasterDevicesIndexes"/> of the device this queue performs updates for.</param>
public CoolerMasterUpdateQueue(IDeviceUpdateTrigger updateTrigger, CoolerMasterDevicesIndexes deviceIndex)
: base(updateTrigger)
{
@@ -7,9 +7,13 @@ namespace RGB.NET.Devices.CoolerMaster.Native
{
#region Constants
// ReSharper disable MemberCanBePrivate.Global
internal const int ROWS = 6;
internal const int COLUMNS = 22;
// ReSharper restore MemberCanBePrivate.Global
#endregion
#region Properties & Fields