Add xmldoc to existing code (#130)

Author: dfederm

src/ZWave.CommandClasses/BasicCommandClass.cs

@@ -18,6 +18,9 @@ public enum BasicCommand : byte
     Report = 0x03,
 }
 
+/// <summary>
+/// Represents the state reported by a Basic Command Class device.
+/// </summary>
 public readonly struct BasicState
 {
     public BasicState(
@@ -57,6 +60,9 @@ internal BasicCommandClass(
     {
     }
 
+    /// <summary>
+    /// Gets the last reported state of the device.
+    /// </summary>
     public BasicState? State { get; private set; }
 
     /// <inheritdoc />

src/ZWave.CommandClasses/BatteryCommandClass.cs

@@ -1,21 +1,36 @@
 namespace ZWave.CommandClasses;
 
+/// <summary>
+/// Represents a battery level value.
+/// </summary>
 public struct BatteryLevel
 {
     public BatteryLevel(byte value)
     {
         Value = value;
     }
 
+    /// <summary>
+    /// Gets the raw battery level byte.
+    /// </summary>
     public byte Value { get; }
 
+    /// <summary>
+    /// Gets the battery level as a percentage (0-100).
+    /// </summary>
     public int Level => Value == 0xff ? 0 : Value;
 
+    /// <summary>
+    /// Gets a value indicating whether the battery level is critically low.
+    /// </summary>
     public bool IsLow => Value == 0xff;
 
     public static implicit operator BatteryLevel(byte b) => new BatteryLevel(b);
 }
 
+/// <summary>
+/// Indicates the charging status of a battery.
+/// </summary>
 public enum BatteryChargingStatus : byte
 {
     Discharging = 0x00,
@@ -25,6 +40,9 @@ public enum BatteryChargingStatus : byte
     Maintaining = 0x02,
 }
 
+/// <summary>
+/// Indicates whether the battery needs to be recharged or replaced.
+/// </summary>
 public enum BatterRechargeOrReplaceStatus : byte
 {
     /// <summary>
@@ -45,6 +63,9 @@ public enum BatterRechargeOrReplaceStatus : byte
     Now = 0x03,
 }
 
+/// <summary>
+/// The temperature scale used for battery temperature readings.
+/// </summary>
 public enum BatteryTemperatureScale : byte
 {
     Celcius = 0x00,
@@ -176,10 +197,17 @@ public BatteryCommandClass(CommandClassInfo info, IDriver driver, INode node)
     {
     }
 
+    /// <summary>
+    /// Gets the last reported battery state.
+    /// </summary>
     public BatteryState? State { get; private set; }
 
+    /// <summary>
+    /// Gets the last reported battery health.
+    /// </summary>
     public BatteryHealth? Health { get; private set; }
 
+    /// <inheritdoc />
     public override bool? IsCommandSupported(BatteryCommand command)
         => command switch
         {

src/ZWave.CommandClasses/BinarySensorCommandClass.cs

@@ -1,20 +1,78 @@
 namespace ZWave.CommandClasses;
 
+/// <summary>
+/// Identifies the type of a binary sensor.
+/// </summary>
 public enum BinarySensorType : byte
 {
+    /// <summary>
+    /// General purpose sensor.
+    /// </summary>
     GeneralPurpose = 0x01,
+
+    /// <summary>
+    /// Smoke sensor.
+    /// </summary>
     Smoke = 0x02,
+
+    /// <summary>
+    /// Carbon monoxide sensor.
+    /// </summary>
     CO = 0x03,
+
+    /// <summary>
+    /// Carbon dioxide sensor.
+    /// </summary>
     CO2 = 0x04,
+
+    /// <summary>
+    /// Heat sensor.
+    /// </summary>
     Heat = 0x05,
+
+    /// <summary>
+    /// Water sensor.
+    /// </summary>
     Water = 0x06,
+
+    /// <summary>
+    /// Freeze sensor.
+    /// </summary>
     Freeze = 0x07,
+
+    /// <summary>
+    /// Tamper sensor.
+    /// </summary>
     Tamper = 0x08,
+
+    /// <summary>
+    /// Auxiliary sensor.
+    /// </summary>
     Aux = 0x09,
+
+    /// <summary>
+    /// Door/window sensor.
+    /// </summary>
     DoorWindow = 0x0a,
+
+    /// <summary>
+    /// Tilt sensor.
+    /// </summary>
     Tilt = 0x0b,
+
+    /// <summary>
+    /// Motion sensor.
+    /// </summary>
     Motion = 0x0c,
+
+    /// <summary>
+    /// Glass break sensor.
+    /// </summary>
     GlassBreak = 0x0d,
+
+    /// <summary>
+    /// Request the first supported sensor type.
+    /// </summary>
     FirstSupported = 0xff,
 }
 
@@ -61,6 +119,7 @@ public BinarySensorCommandClass(CommandClassInfo info, IDriver driver, INode nod
     /// </summary>
     public IReadOnlyDictionary<BinarySensorType, bool?>? SensorValues => _sensorValues;
 
+    /// <inheritdoc />
     public override bool? IsCommandSupported(BinarySensorCommand command)
         => command switch
         {

src/ZWave.CommandClasses/BinarySwitchCommandClass.cs

@@ -18,6 +18,9 @@ public enum BinarySwitchCommand : byte
     Report = 0x03,
 }
 
+/// <summary>
+/// Represents the state reported by a Binary Switch Command Class device.
+/// </summary>
 public readonly struct BinarySwitchState
 {
     public BinarySwitchState(
@@ -54,6 +57,9 @@ internal BinarySwitchCommandClass(CommandClassInfo info, IDriver driver, INode n
     {
     }
 
+    /// <summary>
+    /// Gets the last reported switch state.
+    /// </summary>
     public BinarySwitchState? State { get; private set; }
 
     /// <inheritdoc />

src/ZWave.CommandClasses/ColorSwitchCommandClass.cs

@@ -1,5 +1,8 @@
 namespace ZWave.CommandClasses;
 
+/// <summary>
+/// Identifies a color component of a color switch device.
+/// </summary>
 public enum ColorSwitchColorComponent : byte
 {
     WarmWhite = 0x00,
@@ -21,6 +24,9 @@ public enum ColorSwitchColorComponent : byte
     Index = 0x08,
 }
 
+/// <summary>
+/// The direction of a color switch level change.
+/// </summary>
 public enum ColorSwitchChangeDirection : byte
 {
     Up = 0x00,
@@ -45,15 +51,30 @@ public enum ColorSwitchCommand : byte
     /// </summary>
     Get = 0x03,
 
+    /// <summary>
+    /// Report the status of a specified color component.
+    /// </summary>
     Report = 0x04,
 
+    /// <summary>
+    /// Set the value of one or more color components.
+    /// </summary>
     Set = 0x05,
 
+    /// <summary>
+    /// Initiate a color component level change.
+    /// </summary>
     StartLevelChange = 0x06,
 
+    /// <summary>
+    /// Stop an ongoing color component level change.
+    /// </summary>
     StopLevelChange = 0x07,
 }
 
+/// <summary>
+/// Represents the state of a single color component.
+/// </summary>
 public readonly struct ColorSwitchColorComponentState
 {
     public ColorSwitchColorComponentState(
@@ -102,6 +123,7 @@ public ColorSwitchCommandClass(CommandClassInfo info, IDriver driver, INode node
     /// </summary>
     public IReadOnlyDictionary<ColorSwitchColorComponent, ColorSwitchColorComponentState?>? ColorComponents => _colorComponents;
 
+    /// <inheritdoc />
     public override bool? IsCommandSupported(ColorSwitchCommand command)
         => command switch
         {

src/ZWave.CommandClasses/CommandClass.cs

@@ -2,6 +2,9 @@
 
 namespace ZWave.CommandClasses;
 
+/// <summary>
+/// Base class for command classes with a strongly-typed command enum.
+/// </summary>
 public abstract class CommandClass<TCommand> : CommandClass
     where TCommand : struct, Enum
 {
@@ -28,6 +31,9 @@ internal CommandClass(CommandClassInfo info, IDriver driver, INode node)
         => IsCommandSupported(Unsafe.As<byte, TCommand>(ref command));
 }
 
+/// <summary>
+/// Base class for all Z-Wave command class implementations.
+/// </summary>
 public abstract class CommandClass
 {
     private record struct AwaitedReport(
@@ -52,12 +58,24 @@ internal CommandClass(
         Node = node;
     }
 
+    /// <summary>
+    /// Gets information about this command class, including whether it is supported and/or controlled.
+    /// </summary>
     public CommandClassInfo Info { get; private set; }
 
+    /// <summary>
+    /// Gets the driver used to send commands.
+    /// </summary>
     protected IDriver Driver { get; }
 
+    /// <summary>
+    /// Gets the node this command class belongs to.
+    /// </summary>
     public INode Node { get; }
 
+    /// <summary>
+    /// Gets the version of this command class, or null if not yet determined.
+    /// </summary>
     public byte? Version { get; private set; }
 
     // If we don't know the version, we have to assume it's version 1

src/ZWave.CommandClasses/CommandClassFrame.cs

@@ -1,7 +1,13 @@
 namespace ZWave.CommandClasses;
 
+/// <summary>
+/// Represents a command class frame containing a command class ID, command ID, and optional parameters.
+/// </summary>
 public readonly struct CommandClassFrame
 {
+    /// <summary>
+    /// Initializes a new instance of the <see cref="CommandClassFrame"/> struct from raw payload bytes.
+    /// </summary>
     public CommandClassFrame(ReadOnlyMemory<byte> data)
     {
         if (data.Span.Length < 2)
@@ -12,17 +18,35 @@ public CommandClassFrame(ReadOnlyMemory<byte> data)
         Data = data;
     }
 
+    /// <summary>
+    /// Gets the raw frame data.
+    /// </summary>
     public ReadOnlyMemory<byte> Data { get; }
 
+    /// <summary>
+    /// Gets the command class identifier.
+    /// </summary>
     public CommandClassId CommandClassId => (CommandClassId)Data.Span[0];
 
+    /// <summary>
+    /// Gets the command identifier within the command class.
+    /// </summary>
     public byte CommandId => Data.Span[1];
 
+    /// <summary>
+    /// Gets the command parameters, excluding the command class ID and command ID.
+    /// </summary>
     public ReadOnlyMemory<byte> CommandParameters => Data[2..];
 
+    /// <summary>
+    /// Creates a new command class frame with no command parameters.
+    /// </summary>
     public static CommandClassFrame Create(CommandClassId commandClassId, byte commandId)
         => Create(commandClassId, commandId, ReadOnlySpan<byte>.Empty);
 
+    /// <summary>
+    /// Creates a new command class frame with the specified command parameters.
+    /// </summary>
     public static CommandClassFrame Create(CommandClassId commandClassId, byte commandId, ReadOnlySpan<byte> commandParameters)
     {
         byte[] data = new byte[2 + commandParameters.Length];

src/ZWave.CommandClasses/DurationReport.cs

@@ -13,8 +13,14 @@ public DurationReport(byte value)
         Value = value;
     }
 
+    /// <summary>
+    /// Gets the raw duration byte value.
+    /// </summary>
     public byte Value { get; }
 
+    /// <summary>
+    /// Gets the interpreted duration, or null if unknown.
+    /// </summary>
     public TimeSpan? Duration =>
         Value switch
         {

src/ZWave.CommandClasses/DurationSet.cs

@@ -44,6 +44,9 @@ public DurationSet(TimeSpan duration)
     /// </summary>
     public static DurationSet FactoryDefault => new DurationSet(0xff);
 
+    /// <summary>
+    /// Gets the raw duration byte value.
+    /// </summary>
     public byte Value { get; }
 
     public static implicit operator DurationSet(byte b) => new DurationSet(b);