Fixed some code issues

2025-12-12 17:48:31 +00:00 · 2017-11-26 09:45:24 +01:00 · 2017-11-26 09:45:24 +01:00 · b9e443b3b6
commit b9e443b3b6
parent 67fcc8e52e
23 changed files with 53 additions and 28 deletions
--- a/RGB.NET.Brushes/Brushes/ConicalGradientBrush.cs
+++ b/RGB.NET.Brushes/Brushes/ConicalGradientBrush.cs
@ -10,7 +10,8 @@ using RGB.NET.Core;

 namespace RGB.NET.Brushes
 {
-    /// <inheritdoc />
+    /// <inheritdoc cref="AbstractBrush" />
+    /// <inheritdoc cref="IGradientBrush" />
    /// <summary>
    /// Represents a brush drawing a conical gradient.
    /// </summary>
--- a/RGB.NET.Brushes/Brushes/LinearGradientBrush.cs
+++ b/RGB.NET.Brushes/Brushes/LinearGradientBrush.cs
@ -11,7 +11,8 @@ using RGB.NET.Core;

 namespace RGB.NET.Brushes
 {
-    /// <inheritdoc />
+    /// <inheritdoc cref="AbstractBrush" />
+    /// <inheritdoc cref="IGradientBrush" />
    /// <summary>
    /// Represents a brush drawing a linear gradient.
    /// </summary>
--- a/RGB.NET.Brushes/Brushes/RadialGradientBrush.cs
+++ b/RGB.NET.Brushes/Brushes/RadialGradientBrush.cs
@ -9,7 +9,8 @@ using RGB.NET.Core;

 namespace RGB.NET.Brushes
 {
-    /// <inheritdoc />
+    /// <inheritdoc cref="AbstractBrush" />
+    /// <inheritdoc cref="IGradientBrush" />
    /// <summary>
    /// Represents a brush drawing a radial gradient around a center point.
    /// </summary>
--- a/RGB.NET.Brushes/Gradients/AbstractGradient.cs
+++ b/RGB.NET.Brushes/Gradients/AbstractGradient.cs
@ -8,7 +8,8 @@ using RGB.NET.Core;

 namespace RGB.NET.Brushes.Gradients
 {
-    /// <inheritdoc />
+    /// <inheritdoc cref="AbstractDecoratable{T}" />
+    /// <inheritdoc cref="IGradient" />
    /// <summary>
    /// Represents a basic gradient.
    /// </summary>
--- a/RGB.NET.Brushes/Gradients/RainbowGradient.cs
+++ b/RGB.NET.Brushes/Gradients/RainbowGradient.cs
@ -5,7 +5,8 @@ using RGB.NET.Core;

 namespace RGB.NET.Brushes.Gradients
 {
-    /// <inheritdoc />
+    /// <inheritdoc cref="AbstractDecoratable{T}" />
+    /// <inheritdoc cref="IGradient" />
    /// <summary>
    /// Represents a rainbow gradient which circles through all colors of the HUE-color-space.<br />
    /// See <see href="http://upload.wikimedia.org/wikipedia/commons/a/ad/HueScale.svg" /> as reference.
--- a/RGB.NET.Core/Brushes/AbstractBrush.cs
+++ b/RGB.NET.Core/Brushes/AbstractBrush.cs
@ -7,7 +7,8 @@ using System.Linq;

 namespace RGB.NET.Core
 {
-    /// <inheritdoc />
+    /// <inheritdoc cref="AbstractDecoratable{T}" />
+    /// <inheritdoc cref="IBrush" />
    /// <summary>
    /// Represents a basic brush.
    /// </summary>
--- a/RGB.NET.Core/Decorators/AbstractDecorator.cs
+++ b/RGB.NET.Core/Decorators/AbstractDecorator.cs
@ -2,7 +2,8 @@

 namespace RGB.NET.Core
 {
-    /// <inheritdoc />
+    /// <inheritdoc cref="AbstractBindable" />
+    /// <inheritdoc cref="IDecorator" />
    public abstract class AbstractDecorator : AbstractBindable, IDecorator
    {
        #region Properties & Fields
--- a/RGB.NET.Core/Decorators/AbstractIDecorateable.cs
+++ b/RGB.NET.Core/Decorators/AbstractIDecorateable.cs
@ -4,7 +4,8 @@ using System.Linq;

 namespace RGB.NET.Core
 {
-    /// <inheritdoc />
+    /// <inheritdoc cref="AbstractBindable" />
+    /// <inheritdoc cref="IDecoratable{T}" />
    public abstract class AbstractDecoratable<T> : AbstractBindable, IDecoratable<T>
        where T : IDecorator
    {
--- a/RGB.NET.Core/Devices/AbstractRGBDevice.cs
+++ b/RGB.NET.Core/Devices/AbstractRGBDevice.cs
@ -8,7 +8,8 @@ using System.Linq;

 namespace RGB.NET.Core
 {
-    /// <inheritdoc />
+    /// <inheritdoc cref="AbstractBindable" />
+    /// <inheritdoc cref="IRGBDevice{TDeviceInfo}" />
    /// <summary>
    /// Represents a generic RGB-device
    /// </summary>
--- a/RGB.NET.Core/Devices/IRGBDevice.cs
+++ b/RGB.NET.Core/Devices/IRGBDevice.cs
@ -3,7 +3,9 @@ using System.Collections.Generic;

 namespace RGB.NET.Core
 {
-    /// <inheritdoc />
+    /// <inheritdoc cref="IEnumerable{T}" />
+    /// <inheritdoc cref="IBindable" />
+    /// <inheritdoc cref="IDisposable" />
    /// <summary>
    /// Represents a generic RGB-device.
    /// </summary>
--- a/RGB.NET.Core/Groups/AbstractLedGroup.cs
+++ b/RGB.NET.Core/Groups/AbstractLedGroup.cs
@ -2,7 +2,8 @@

 namespace RGB.NET.Core
 {
-    /// <inheritdoc />
+    /// <inheritdoc cref="AbstractDecoratable{T}" />
+    /// <inheritdoc cref="ILedGroup" />
    /// <summary>
    /// Represents a generic <see cref="T:RGB.NET.Core.AbstractLedGroup" />.
    /// </summary>
--- a/RGB.NET.Core/RGBSurface.cs
+++ b/RGB.NET.Core/RGBSurface.cs
@ -8,7 +8,8 @@ using System.Linq;

 namespace RGB.NET.Core
 {
-    /// <inheritdoc />
+    /// <inheritdoc cref="AbstractBindable" />
+    /// <inheritdoc cref="IDisposable" />
    /// <summary>
    /// Represents a RGB-surface containing multiple devices.
    /// </summary>
--- a/RGB.NET.Decorators/Brush/FlashDecorator.cs
+++ b/RGB.NET.Decorators/Brush/FlashDecorator.cs
@ -7,7 +7,8 @@ using RGB.NET.Core;

 namespace RGB.NET.Decorators.Brush
 {
-    /// <inheritdoc />
+    /// <inheritdoc cref="AbstractUpdateAwareDecorator" />
+    /// <inheritdoc cref="IBrushDecorator" />
    /// <summary>
    /// Represents a decorator which allows to flash a brush by modifying his opacity.
    /// </summary>
@ -131,7 +132,8 @@ namespace RGB.NET.Decorators.Brush
            // ReSharper restore InvertIf
        }

-        /// <inheritdoc />
+        /// <inheritdoc cref="AbstractUpdateAwareDecorator.OnAttached" />
+        /// <inheritdoc cref="IDecorator.OnAttached" />
        public override void OnAttached(IDecoratable decoratable)
        {
            base.OnAttached(decoratable);
--- a/RGB.NET.Decorators/Gradient/MoveGradientDecorator.cs
+++ b/RGB.NET.Decorators/Gradient/MoveGradientDecorator.cs
@ -4,7 +4,8 @@ using RGB.NET.Core;

 namespace RGB.NET.Decorators.Gradient
 {
-    /// <inheritdoc />
+    /// <inheritdoc cref="AbstractUpdateAwareDecorator" />
+    /// <inheritdoc cref="IGradientDecorator" />
    /// <summary>
    /// Represents a decorator which allows to move an <see cref="T:RGB.NET.Brushes.Gradients.IGradient" /> by modifying his offset.
    /// </summary>
--- a/RGB.NET.Devices.Asus/Generic/AsusRGBDevice.cs
+++ b/RGB.NET.Devices.Asus/Generic/AsusRGBDevice.cs
@ -8,7 +8,8 @@ using RGB.NET.Core.Layout;

 namespace RGB.NET.Devices.Asus
 {
-    /// <inheritdoc />
+    /// <inheritdoc cref="AbstractRGBDevice{TDeviceInfo}" />
+    /// <inheritdoc cref="IAsusRGBDevice" />
    /// <summary>
    /// Represents a generic Asus-device. (keyboard, mouse, headset, mousepad).
    /// </summary>
@ -130,7 +131,8 @@ namespace RGB.NET.Devices.Asus
        /// </summary>
        protected abstract void ApplyColorData();

-        /// <inheritdoc />
+        /// <inheritdoc cref="IDisposable.Dispose" />
+        /// <inheritdoc cref="AbstractRGBDevice{TDeviceInfo}.Dispose" />
        public override void Dispose()
        {
            if ((DeviceInfo is AsusRGBDeviceInfo deviceInfo) && (deviceInfo.Handle != IntPtr.Zero))
--- a/RGB.NET.Devices.Asus/Generic/AsusRGBDeviceInfo.cs
+++ b/RGB.NET.Devices.Asus/Generic/AsusRGBDeviceInfo.cs
@ -27,7 +27,7 @@ namespace RGB.NET.Devices.Asus
        public RGBDeviceLighting Lighting => RGBDeviceLighting.Key;

        /// <summary>
-        /// Gets the index of the <see cref="AsusRGBDevice"/>.
+        /// Gets the index of the <see cref="AsusRGBDevice{TDeviceInfo}"/>.
        /// </summary>
        internal IntPtr Handle { get; }

--- a/RGB.NET.Devices.CoolerMaster/Generic/CoolerMasterRGBDevice.cs
+++ b/RGB.NET.Devices.CoolerMaster/Generic/CoolerMasterRGBDevice.cs
@ -8,7 +8,8 @@ using RGB.NET.Devices.CoolerMaster.Native;

 namespace RGB.NET.Devices.CoolerMaster
 {
-    /// <inheritdoc />
+    /// <inheritdoc cref="AbstractRGBDevice{TDeviceInfo}" />
+    /// <inheritdoc cref="ICoolerMasterRGBDevice" />
    /// <summary>
    /// Represents a generic CoolerMaster-device. (keyboard, mouse, headset, mousepad).
    /// </summary>
@ -118,7 +119,8 @@ namespace RGB.NET.Devices.CoolerMaster
            }
        }

-        /// <inheritdoc />
+        /// <inheritdoc cref="IDisposable.Dispose" />
+        /// <inheritdoc cref="AbstractRGBDevice{TDeviceInfo}.Dispose" />
        public override void Dispose()
        {
            _CoolerMasterSDK.SetControlDevice(DeviceInfo.DeviceIndex);
--- a/RGB.NET.Devices.CoolerMaster/Generic/CoolerMasterRGBDeviceInfo.cs
+++ b/RGB.NET.Devices.CoolerMaster/Generic/CoolerMasterRGBDeviceInfo.cs
@ -28,7 +28,7 @@ namespace RGB.NET.Devices.CoolerMaster
        public RGBDeviceLighting Lighting => RGBDeviceLighting.Key;

        /// <summary>
-        /// Gets the <see cref="CoolerMasterDevicesIndexes"/> of the <see cref="CoolerMasterRGBDevice"/>.
+        /// Gets the <see cref="CoolerMasterDevicesIndexes"/> of the <see cref="CoolerMasterRGBDevice{TDeviceInfo}"/>.
        /// </summary>
        public CoolerMasterDevicesIndexes DeviceIndex { get; }

--- a/RGB.NET.Devices.Corsair/Generic/CorsairRGBDevice.cs
+++ b/RGB.NET.Devices.Corsair/Generic/CorsairRGBDevice.cs
@ -9,7 +9,8 @@ using RGB.NET.Devices.Corsair.Native;

 namespace RGB.NET.Devices.Corsair
 {
-    /// <inheritdoc />
+    /// <inheritdoc cref="AbstractRGBDevice{TDeviceInfo}" />
+    /// <inheritdoc cref="ICorsairRGBDevice" />
    /// <summary>
    /// Represents a generic CUE-device. (keyboard, mouse, headset, mousepad).
    /// </summary>
--- a/RGB.NET.Devices.Corsair/Generic/CorsairRGBDeviceInfo.cs
+++ b/RGB.NET.Devices.Corsair/Generic/CorsairRGBDeviceInfo.cs
@ -19,7 +19,7 @@ namespace RGB.NET.Devices.Corsair
        public CorsairDeviceType CorsairDeviceType { get; }

        /// <summary>
-        /// Gets the index of the <see cref="CorsairRGBDevice"/>.
+        /// Gets the index of the <see cref="CorsairRGBDevice{TDeviceInfo}"/>.
        /// </summary>
        public int CorsairDeviceIndex { get; }

@ -50,7 +50,7 @@ namespace RGB.NET.Devices.Corsair
        /// <summary>
        /// Internal constructor of managed <see cref="CorsairRGBDeviceInfo"/>.
        /// </summary>
-        /// <param name="deviceIndex">The index of the <see cref="CorsairRGBDevice"/>.</param>
+        /// <param name="deviceIndex">The index of the <see cref="CorsairRGBDevice{TDeviceInfo}"/>.</param>
        /// <param name="deviceType">The type of the <see cref="IRGBDevice"/>.</param>
        /// <param name="nativeInfo">The native <see cref="_CorsairDeviceInfo" />-struct</param>
        internal CorsairRGBDeviceInfo(int deviceIndex, RGBDeviceType deviceType, _CorsairDeviceInfo nativeInfo)
--- a/RGB.NET.Devices.Logitech/Generic/LogitechRGBDevice.cs
+++ b/RGB.NET.Devices.Logitech/Generic/LogitechRGBDevice.cs
@ -6,7 +6,8 @@ using RGB.NET.Core.Layout;

 namespace RGB.NET.Devices.Logitech
 {
-    /// <inheritdoc />
+    /// <inheritdoc cref="AbstractRGBDevice{TDeviceInfo}" />
+    /// <inheritdoc cref="ILogitechRGBDevice" />
    /// <summary>
    /// Represents a generic Logitech-device. (keyboard, mouse, headset, mousepad).
    /// </summary>
--- a/RGB.NET.Devices.Msi/Generic/MsiRGBDevice.cs
+++ b/RGB.NET.Devices.Msi/Generic/MsiRGBDevice.cs
@ -8,7 +8,8 @@ using RGB.NET.Devices.Msi.Native;

 namespace RGB.NET.Devices.Msi
 {
-    /// <inheritdoc />
+    /// <inheritdoc cref="AbstractRGBDevice{TDeviceInfo}" />
+    /// <inheritdoc cref="IMsiRGBDevice" />
    /// <summary>
    /// Represents a generic Msi-device. (keyboard, mouse, headset, mousepad).
    /// </summary>
--- a/RGB.NET.Devices.Novation/Generic/NovationRGBDevice.cs
+++ b/RGB.NET.Devices.Novation/Generic/NovationRGBDevice.cs
@ -8,7 +8,8 @@ using Sanford.Multimedia.Midi;

 namespace RGB.NET.Devices.Novation
 {
-    /// <inheritdoc />
+    /// <inheritdoc cref="AbstractRGBDevice{TDeviceInfo}" />
+    /// <inheritdoc cref="INovationRGBDevice" />
    /// <summary>
    /// Represents a generic Novation-device. (launchpad).
    /// </summary>
@ -190,7 +191,8 @@ namespace RGB.NET.Devices.Novation
            _outputDevice.SendShort(shortMessage.Message);
        }

-        /// <inheritdoc />
+        /// <inheritdoc cref="IDisposable.Dispose" />
+        /// <inheritdoc cref="AbstractRGBDevice{TDeviceInfo}.Dispose" />
        public override void Dispose()
        {
            Reset();