Added missing comments

This commit is contained in:
DarthAffe committed 2016-08-21 20:06:02 +02:00
1 parent 8d32c73b6d
commit 0fc32243c8
12 files changed
+92 -2

No files matched your search

+14
View File
@@ -5,18 +5,32 @@ using System.Drawing;
namespace CUE.NET.Devices.Generic
{
/// <summary>
/// Represents a request to update a led.
/// </summary>
public class LedUpateRequest
{
#region Properties & Fields
/// <summary>
/// Gets the id of the led to update.
/// </summary>
public int LedId { get; }
/// <summary>
/// Gets the requested color of the led.
/// </summary>
public Color Color { get; set; }
#endregion
#region Constructors
/// <summary>
/// Initializes a new instance of the <see cref="LedUpateRequest"/> class.
/// </summary>
/// <param name="ledId">The id of the led to update.</param>
/// <param name="color">The requested color of the led.</param>
public LedUpateRequest(int ledId, Color color)
{
this.LedId = ledId;
+20 -1
View File
@@ -181,7 +181,11 @@ namespace CUE.NET.Devices.Keyboard
// ReSharper disable once CatchAllClause
catch (Exception ex) { OnException(ex); }
}
/// <summary>
/// Gets a list containing all LEDs of this group.
/// </summary>
/// <returns>The list containing all LEDs of this group.</returns>
public IEnumerable<CorsairLed> GetLeds()
{
return this.Select(x => x.Led);
@@ -242,16 +246,27 @@ namespace CUE.NET.Devices.Keyboard
#region Effects
/// <summary>
/// NOT IMPLEMENTED: Effects can't be applied directly to the keyboard. Add it to the Brush or create a keygroup instead.
/// </summary>
public void UpdateEffects()
{
throw new NotSupportedException("Effects can't be applied directly to the keyboard. Add it to the Brush or create a keygroup instead.");
}
/// <summary>
/// NOT IMPLEMENTED: Effects can't be applied directly to the keyboard. Add it to the Brush or create a keygroup instead.
/// </summary>
/// <param name="effect">The effect to add.</param>
public void AddEffect(IEffect<IKeyGroup> effect)
{
throw new NotSupportedException("Effects can't be applied directly to the keyboard. Add it to the Brush or create a keygroup instead.");
}
/// <summary>
/// NOT IMPLEMENTED: Effects can't be applied directly to the keyboard. Add it to the Brush or create a keygroup instead.
/// </summary>
/// <param name="effect">The effect to remove.</param>
public void RemoveEffect(IEffect<IKeyGroup> effect)
{
throw new NotSupportedException("Effects can't be applied directly to the keyboard. Add it to the Brush or create a keygroup instead.");
@@ -270,6 +285,10 @@ namespace CUE.NET.Devices.Keyboard
return _keys.Values.GetEnumerator();
}
/// <summary>
/// Returns an enumerator that iterates over all keys of the keyboard.
/// </summary>
/// <returns>An enumerator for all keys of the keyboard.</returns>
IEnumerator IEnumerable.GetEnumerator()
{
return GetEnumerator();