Add XML documentation across gateway, worker, and .NET client
This commit is contained in:
@@ -6,8 +6,11 @@ using MxGateway.Contracts.Proto;
|
||||
|
||||
namespace MxGateway.Worker.Conversion;
|
||||
|
||||
/// <summary>Converts MXAccess MXSTATUS_PROXY COM objects to protobuf MxStatusProxy messages.</summary>
|
||||
public sealed class MxStatusProxyConverter
|
||||
{
|
||||
/// <summary>Converts a single status object to a protobuf message, reflecting all fields and diagnostics.</summary>
|
||||
/// <param name="status">COM status object to convert.</param>
|
||||
public MxStatusProxy Convert(object status)
|
||||
{
|
||||
if (status is null)
|
||||
@@ -33,6 +36,8 @@ public sealed class MxStatusProxyConverter
|
||||
};
|
||||
}
|
||||
|
||||
/// <summary>Converts an array of status objects, handling nulls gracefully.</summary>
|
||||
/// <param name="statuses">Array of COM status objects; null returns empty list.</param>
|
||||
public IReadOnlyList<MxStatusProxy> ConvertMany(Array? statuses)
|
||||
{
|
||||
if (statuses is null)
|
||||
@@ -60,6 +65,8 @@ public sealed class MxStatusProxyConverter
|
||||
return converted;
|
||||
}
|
||||
|
||||
/// <summary>Preserves completion-only status bytes as a diagnostic hex string since they cannot be unpacked.</summary>
|
||||
/// <param name="statusBytes">Status bytes to encode as hex string.</param>
|
||||
public string PreserveCompletionOnlyStatusBytes(byte[] statusBytes)
|
||||
{
|
||||
if (statusBytes is null)
|
||||
|
||||
Reference in New Issue
Block a user