Merge pull request #921 from WildernessLabs/led_contracts

Cleanup contracts

Source/Meadow.Foundation.Core/Leds/Led.Animations.cs

@@ -15,9 +15,7 @@ public partial class Led
         private CancellationTokenSource? cancellationTokenSource = null;
 
 
-        /// <summary>
-        /// Stops the current LED animation
-        /// </summary>
+        /// <inheritdoc/>
         public async Task StopAnimation()
         {
             if (animationTask != null)
@@ -29,19 +27,13 @@ public async Task StopAnimation()
             }
         }
 
-        /// <summary>
-        /// Start the Blink animation which sets turns the LED on and off on an interval of 1 second (500ms on, 500ms off)
-        /// </summary>
+        /// <inheritdoc/>
         public Task StartBlink()
         {
             return StartBlink(TimeSpan.FromMilliseconds(500), TimeSpan.FromMilliseconds(500));
         }
 
-        /// <summary>
-        /// Start the Blink animation which sets turns the LED on and off with the specified durations
-        /// </summary>
-        /// <param name="onDuration">The duration the LED stays on</param>
-        /// <param name="offDuration">The duration the LED stays off</param>
+        /// <inheritdoc/>
         public async Task StartBlink(TimeSpan onDuration, TimeSpan offDuration)
         {
             await StopAnimation();

Source/Meadow.Foundation.Core/Leds/Led.cs

@@ -11,9 +11,7 @@ public partial class Led : ILed, IDisposable
     {
         readonly bool createdPort = false;
 
-        /// <summary>
-        /// Turns on LED with current color or turns it off
-        /// </summary>
+        /// <inheritdoc/>
         public bool IsOn
         {
             get => isOn;

Source/Meadow.Foundation.Core/Leds/PwmLed.Animations.cs

@@ -6,14 +6,12 @@ namespace Meadow.Foundation.Leds
 {
     public partial class PwmLed
     {
-        private readonly object syncRoot = new object();
+        private readonly object syncRoot = new();
 
         private Task? animationTask = null;
         private CancellationTokenSource? cancellationTokenSource = null;
 
-        /// <summary>
-        /// Stops any running animations.
-        /// </summary>
+        /// <inheritdoc/>
         public async Task StopAnimation()
         {
             if (animationTask != null)
@@ -25,12 +23,20 @@ public async Task StopAnimation()
             }
         }
 
-        /// <summary>
-        /// Start a Blink animation which sets the brightness of the LED alternating between a low and high brightness setting.
-        /// </summary>
-        /// <param name="highBrightness">The maximum brightness of the animation</param>
-        /// <param name="lowBrightness">The minimum brightness of the animation</param>
-        public async Task StartBlink(float highBrightness = 1f, float lowBrightness = 0f)
+        /// <inheritdoc/>
+        public Task StartBlink()
+        {
+            return StartBlink(1f, 0f);
+        }
+
+        /// <inheritdoc/>
+        public Task StartBlink(TimeSpan onDuration, TimeSpan offDuration)
+        {
+            return StartBlink(TimeSpan.FromMilliseconds(500), TimeSpan.FromMilliseconds(500));
+        }
+
+        /// <inheritdoc/>
+        public async Task StartBlink(float highBrightness, float lowBrightness)
         {
             ValidateBrightness(highBrightness, lowBrightness);
 
@@ -39,13 +45,7 @@ public async Task StartBlink(float highBrightness = 1f, float lowBrightness = 0f
             await StartBlink(TimeSpan.FromMilliseconds(500), TimeSpan.FromMilliseconds(500));
         }
 
-        /// <summary>
-        /// Start the Blink animation which sets the brightness of the LED alternating between a low and high brightness setting, using the durations provided.
-        /// </summary>
-        /// <param name="highBrightnessDuration">The duration the LED stays in high brightness</param>
-        /// <param name="lowBrightnessDuration">The duration the LED stays in low brightness</param>
-        /// <param name="highBrightness">The maximum brightness of the animation</param>
-        /// <param name="lowBrightness">The minimum brightness of the animation</param>
+        /// <inheritdoc/>
         public async Task StartBlink(
             TimeSpan highBrightnessDuration,
             TimeSpan lowBrightnessDuration,
@@ -76,11 +76,7 @@ public async Task StartBlink(
             }
         }
 
-        /// <summary>
-        /// Start the Pulse animation which gradually alternates the brightness of the LED between a low and high brightness setting.
-        /// </summary>
-        /// <param name="highBrightness">The maximum brightness of the animation</param>
-        /// <param name="lowBrightness">The minimum brightness of the animation</param>
+        /// <inheritdoc/>
         public async Task StartPulse(float highBrightness = 1, float lowBrightness = 0.15F)
         {
             ValidateBrightness(highBrightness, lowBrightness);
@@ -90,12 +86,7 @@ public async Task StartPulse(float highBrightness = 1, float lowBrightness = 0.1
             await StartPulse(TimeSpan.FromMilliseconds(600), highBrightness, lowBrightness);
         }
 
-        /// <summary>
-        /// Start the Pulse animation which gradually alternates the brightness of the LED between a low and high brightness setting, using the durations provided.
-        /// </summary>
-        /// <param name="pulseDuration">The pulse animation duration</param>
-        /// <param name="highBrightness">The maximum brightness of the animation</param>
-        /// <param name="lowBrightness">The minimum brightness of the animation</param>
+        /// <inheritdoc/>
         public async Task StartPulse(
             TimeSpan pulseDuration,
             float highBrightness = 1,
@@ -113,7 +104,7 @@ public async Task StartPulse(
                 {
                     float brightness = lowBrightness;
                     bool ascending = true;
-                    var intervalTime = TimeSpan.FromMilliseconds(16); // aiming at 60fps to avoid visible steps in brightness changes
+                    var intervalTime = TimeSpan.FromMilliseconds(16);
                     float steps = (float)(pulseDuration.TotalMilliseconds / intervalTime.TotalMilliseconds);
                     float delta = (highBrightness - lowBrightness) / steps;
 

Source/Meadow.Foundation.Core/Leds/PwmLed.cs

@@ -25,9 +25,7 @@ public partial class PwmLed : IPwmLed, IDisposable
         /// </summary>
         public Voltage MIN_FORWARD_VOLTAGE => new Voltage(0);
 
-        /// <summary>
-        /// Turns on LED with current color or turns it off
-        /// </summary>
+        /// <inheritdoc/>
         public bool IsOn
         {
             get => isOn;
@@ -49,9 +47,7 @@ public bool IsOn
         /// </summary>
         public Voltage ForwardVoltage { get; protected set; }
 
-        /// <summary>
-        /// The brightness value assigned to the LED
-        /// </summary>
+        /// <inheritdoc/>
         public float Brightness { get; protected set; } = 1f;
 
         /// <summary>
@@ -115,10 +111,7 @@ protected void ValidateForwardVoltages(Voltage forwardVoltage)
             }
         }
 
-        /// <summary>
-        /// Sets the LED to a specific brightness.
-        /// </summary>
-        /// <param name="brightness">Valid values are from 0 to 1, inclusive</param>
+        /// <inheritdoc/>
         public void SetBrightness(float brightness)
         {
             if (brightness < 0 || brightness > 1)

Source/Meadow.Foundation.Core/Leds/RgbLed.cs

@@ -36,9 +36,7 @@ public partial class RgbLed : IRgbLed, IDisposable
         /// </summary>
         public CommonType Common { get; protected set; }
 
-        /// <summary>
-        /// Turns on LED with current color or turns it off
-        /// </summary>
+        /// <inheritdoc/>
         public bool IsOn
         {
             get => isOn;