Warning cleanup

WildernessLabs · Mar 28, 2024 · bc99bec · bc99bec
1 parent 845e0c0
commit bc99bec
Show file tree

Hide file tree

Showing 9 changed files with 65 additions and 40 deletions.
diff --git a/Source/4-ChannelSpdtRelay/Driver/Stm32Expander/Stm32Expander.PinDefinitions.cs b/Source/4-ChannelSpdtRelay/Driver/Stm32Expander/Stm32Expander.PinDefinitions.cs
@@ -14,7 +14,7 @@ public class PinDefinitions : IPinDefinitions
             /// <summary>
             /// The controller for the pins
             /// </summary>
-            public IPinController Controller { get; set; }
+            public IPinController? Controller { get; set; }
 
             /// <summary>
             /// List of pins

diff --git a/Source/LineFinder/Driver/LineFinder.cs b/Source/LineFinder/Driver/LineFinder.cs
@@ -13,7 +13,17 @@ public class LineFinder
         /// <summary>
         /// Returns Line Color
         /// </summary>
-        public enum LineColor { White, Black }
+        public enum LineColor
+        {
+            /// <summary>
+            /// White lines
+            /// </summary>
+            White,
+            /// <summary>
+            /// Black lines
+            /// </summary>
+            Black
+        }
 
         /// <summary>
         /// Last state of the Line Finder

diff --git a/Source/LoudnessSensor/Driver/LoudnessSensor.cs b/Source/LoudnessSensor/Driver/LoudnessSensor.cs
@@ -13,23 +13,19 @@ public class LoudnessSensor : AnalogSamplingBase
         /// <summary>
         /// Creates a new LoudnessSensor driver
         /// </summary>
-        /// <param name="port"></param>
+        /// <param name="port">Analog port connected to the sensor.</param>
         public LoudnessSensor(IAnalogInputPort port) : base(port)
         { }
 
         /// <summary>
         /// Creates a new LoudnessSensor driver
         /// </summary>
-        /// <param name="pin">AnalogChannel connected to the sensor.</param>
-        public LoudnessSensor(
-            IPin pin,
-            int sampleCount = 5,
-            TimeSpan? sampleInterval = null,
-            Voltage? voltage = null)
-            : this(pin.CreateAnalogInputPort(
-                      sampleCount,
-                      sampleInterval ?? TimeSpan.FromMilliseconds(40),
-                      voltage ?? new Voltage(3.3)))
+        /// <param name="pin">Analog pin connected to the sensor.</param>
+        /// <param name="sampleCount">The number of samples to take during each reading.</param>
+        /// <param name="sampleInterval">The interval between each sample.</param>
+        /// <param name="referenceVoltage">The reference voltage for the analog input port.</param>
+        public LoudnessSensor(IPin pin, int sampleCount = 5, TimeSpan? sampleInterval = null, Voltage? referenceVoltage = null)
+            : this(pin.CreateAnalogInputPort(sampleCount, sampleInterval ?? TimeSpan.FromMilliseconds(40), referenceVoltage ?? new Voltage(3.3)))
         { }
     }
 }
diff --git a/Source/MoistureSensor/Driver/MoistureSensor.cs b/Source/MoistureSensor/Driver/MoistureSensor.cs
@@ -13,24 +13,20 @@ public class MoistureSensor : AnalogSamplingBase
         /// <summary>
         /// Creates a new MoistureSensor driver
         /// </summary>
-        /// <param name="port"></param>
+        /// <param name="port">Analog port connected to the sensor.</param>
         public MoistureSensor(IAnalogInputPort port)
             : base(port)
         { }
 
         /// <summary>
         /// Creates a new MoistureSensor driver
         /// </summary>
-        /// <param name="pin">AnalogChannel connected to the sensor.</param>
-        public MoistureSensor(
-            IPin pin,
-            int sampleCount = 5,
-            TimeSpan? sampleInterval = null,
-            Voltage? voltage = null)
-            : this(pin.CreateAnalogInputPort(
-                      sampleCount,
-                      sampleInterval ?? TimeSpan.FromMilliseconds(40),
-                      voltage ?? new Voltage(3.3)))
+        /// <param name="pin">Analog pin connected to the sensor.</param>
+        /// <param name="sampleCount">The number of samples to take during each reading.</param>
+        /// <param name="sampleInterval">The interval between each sample.</param>
+        /// <param name="referenceVoltage">The reference voltage for the analog input port.</param>
+        public MoistureSensor(IPin pin, int sampleCount = 5, TimeSpan? sampleInterval = null, Voltage? referenceVoltage = null)
+            : this(pin.CreateAnalogInputPort(sampleCount, sampleInterval ?? TimeSpan.FromMilliseconds(40), referenceVoltage ?? new Voltage(3.3)))
         { }
     }
 }
diff --git a/Source/RotaryAngleSensor/Driver/RotaryAngleSensor.cs b/Source/RotaryAngleSensor/Driver/RotaryAngleSensor.cs
@@ -21,8 +21,11 @@ public RotaryAngleSensor(IAnalogInputPort port) : base(port)
         /// Creates a new RotaryAngleSensor driver
         /// </summary>
         /// <param name="pin">AnalogChannel connected to the sensor.</param>
-        public RotaryAngleSensor(IPin pin, int sampleCount = 5, TimeSpan? sampleInterval = null, Voltage? voltage = null)
-            : this(pin.CreateAnalogInputPort(sampleCount, sampleInterval ?? TimeSpan.FromMilliseconds(40), voltage ?? new Voltage(3.3)))
+        /// <param name="sampleCount">The number of samples to take during each reading.</param>
+        /// <param name="sampleInterval">The interval between each sample.</param>
+        /// <param name="referenceVoltage">The reference voltage for the analog input port.</param>
+        public RotaryAngleSensor(IPin pin, int sampleCount = 5, TimeSpan? sampleInterval = null, Voltage? referenceVoltage = null)
+            : this(pin.CreateAnalogInputPort(sampleCount, sampleInterval ?? TimeSpan.FromMilliseconds(40), referenceVoltage ?? new Voltage(3.3)))
         { }
     }
 }
diff --git a/Source/SoundSensor/Driver/SoundSensor.cs b/Source/SoundSensor/Driver/SoundSensor.cs
@@ -13,15 +13,18 @@ public class SoundSensor : AnalogSamplingBase
         /// <summary>
         /// Creates a new SoundSensor driver
         /// </summary>
-        /// <param name="pin">AnalogChannel connected to the sensor.</param>
-        public SoundSensor(IPin pin, int sampleCount = 5, TimeSpan? sampleInterval = null, Voltage? voltage = null)
-            : this(pin.CreateAnalogInputPort(sampleCount, sampleInterval ?? TimeSpan.FromMilliseconds(40), voltage ?? new Voltage(3.3)))
+        /// <param name="pin">Analog pin connected to the sensor.</param>
+        /// <param name="sampleCount">The number of samples to take during each reading.</param>
+        /// <param name="sampleInterval">The interval between each sample.</param>
+        /// <param name="referenceVoltage">The reference voltage for the analog input port.</param>
+        public SoundSensor(IPin pin, int sampleCount = 5, TimeSpan? sampleInterval = null, Voltage? referenceVoltage = null)
+            : this(pin.CreateAnalogInputPort(sampleCount, sampleInterval ?? TimeSpan.FromMilliseconds(40), referenceVoltage ?? new Voltage(3.3)))
         { }
 
         /// <summary>
         /// Creates a new SoundSensor driver
         /// </summary>
-        /// <param name="port"></param>
+        /// <param name="port">Analog port connected to the sensor</param>
         public SoundSensor(IAnalogInputPort port) : base(port)
         { }
     }

diff --git a/Source/TemperatureSensor/Driver/TemperatureSensor.cs b/Source/TemperatureSensor/Driver/TemperatureSensor.cs
@@ -13,15 +13,18 @@ public class TemperatureSensor : AnalogSamplingBase
         /// <summary>
         /// Creates a new TemperatureSensor driver
         /// </summary>
-        /// <param name="pin">AnalogChannel connected to the sensor.</param>
-        public TemperatureSensor(IPin pin, int sampleCount = 5, TimeSpan? sampleInterval = null, Voltage? voltage = null)
-            : this(pin.CreateAnalogInputPort(sampleCount, sampleInterval ?? TimeSpan.FromMilliseconds(40), voltage ?? new Voltage(3.3)))
+        /// <param name="pin">Analog pin connected to the sensor.</param>
+        /// <param name="sampleCount">The number of samples to take during each reading.</param>
+        /// <param name="sampleInterval">The interval between each sample.</param>
+        /// <param name="referenceVoltage">The reference voltage for the analog input port.</param>
+        public TemperatureSensor(IPin pin, int sampleCount = 5, TimeSpan? sampleInterval = null, Voltage? referenceVoltage = null)
+            : this(pin.CreateAnalogInputPort(sampleCount, sampleInterval ?? TimeSpan.FromMilliseconds(40), referenceVoltage ?? new Voltage(3.3)))
         { }
 
         /// <summary>
         /// Creates a new TemperatureSensor driver
         /// </summary>
-        /// <param name="port"></param>
+        /// <param name="port">Analog port connected to the sensor</param>
         public TemperatureSensor(IAnalogInputPort port) : base(port)
         { }
     }

diff --git a/Source/ThumbJoystick/Driver/ThumbJoystick.cs b/Source/ThumbJoystick/Driver/ThumbJoystick.cs
@@ -15,7 +15,7 @@ public class ThumbJoystick : AnalogJoystick
         /// <param name="horizontalPin"></param>
         /// <param name="verticalPin"></param>
         /// <param name="calibration">Calibration for the joystick.</param>
-        public ThumbJoystick(IPin horizontalPin, IPin verticalPin, JoystickCalibration calibration = null)
+        public ThumbJoystick(IPin horizontalPin, IPin verticalPin, JoystickCalibration? calibration = null)
             : base(horizontalPin, verticalPin, calibration)
         { }
 
@@ -32,7 +32,7 @@ public ThumbJoystick(IPin horizontalPin, IPin verticalPin, JoystickCalibration c
         public ThumbJoystick(
             IPin horizontalPin,
             IPin verticalPin,
-            JoystickCalibration calibration,
+            JoystickCalibration? calibration,
             int sampleCount,
             TimeSpan sampleInterval)
             : base(horizontalPin,
@@ -51,7 +51,7 @@ public ThumbJoystick(
         public ThumbJoystick(
             IAnalogInputPort horizontalInputPort,
             IAnalogInputPort verticalInputPort,
-            JoystickCalibration calibration = null)
+            JoystickCalibration? calibration = null)
             : base(
                   horizontalInputPort,
                   verticalInputPort,

diff --git a/Source/WaterSensor/Driver/WaterSensor.cs b/Source/WaterSensor/Driver/WaterSensor.cs
@@ -4,14 +4,28 @@
 
 namespace Meadow.Foundation.Grove.Sensors.Environmental
 {
+    /// <summary>
+    /// Represents a water sensor that can detect the level of water.
+    /// </summary>
     public class WaterSensor : AnalogWaterLevel
     {
-        public WaterSensor(IAnalogInputPort analogInputPort, Calibration calibration = null)
+        /// <summary>
+        /// Initializes a new instance of the WaterSensor class using a specified analog input port.
+        /// </summary>
+        /// <param name="analogInputPort">The analog input port to read water level data from.</param>
+        /// <param name="calibration">Optional calibration parameter for the sensor. If null, default calibration is used.</param>
+        public WaterSensor(IAnalogInputPort analogInputPort, Calibration? calibration = null)
             : base(analogInputPort, calibration)
         { }
 
-        public WaterSensor(IPin analogPin, Calibration calibration = null, TimeSpan? updateInterval = null)
+        /// <summary>
+        /// Initializes a new instance of the WaterSensor class using a specified analog pin.
+        /// </summary>
+        /// <param name="analogPin">The analog pin to read water level data from.</param>
+        /// <param name="calibration">Optional calibration parameter for the sensor. If null, default calibration is used.</param>
+        /// <param name="updateInterval">Optional parameter to specify how often the sensor readings are updated. If null, the default update interval is used.</param>
+        public WaterSensor(IPin analogPin, Calibration? calibration = null, TimeSpan? updateInterval = null)
             : base(analogPin, calibration, updateInterval)
         { }
     }
-}
+}