docs: complete XML doc comments via fixdocs (2757 to 131 findings)
Add missing <returns>/<param>/<summary>/<typeparam> tags and clean up misused inheritdoc across 481 files so the documented API surface is complete. Documentation-only (zero code lines changed). The 131 remaining findings are inheritdoc-style warnings deliberately left to preserve hand-written implementation rationale (plan-decision notes, race-condition explanations).
This commit is contained in:
@@ -377,9 +377,7 @@ public sealed class EquipmentNodeWalkerTests
|
||||
/// <summary>Gets the list of properties.</summary>
|
||||
public List<RecordingProperty> Properties { get; } = new();
|
||||
|
||||
/// <summary>Creates a folder child node.</summary>
|
||||
/// <param name="name">The browse name of the folder.</param>
|
||||
/// <param name="_">The display name (unused).</param>
|
||||
/// <inheritdoc />
|
||||
public IAddressSpaceBuilder Folder(string name, string _)
|
||||
{
|
||||
var child = new RecordingBuilder(name);
|
||||
@@ -387,10 +385,7 @@ public sealed class EquipmentNodeWalkerTests
|
||||
return child;
|
||||
}
|
||||
|
||||
/// <summary>Creates a variable node.</summary>
|
||||
/// <param name="name">The browse name of the variable.</param>
|
||||
/// <param name="_">The display name (unused).</param>
|
||||
/// <param name="attr">The attribute information for the variable.</param>
|
||||
/// <inheritdoc />
|
||||
public IVariableHandle Variable(string name, string _, DriverAttributeInfo attr)
|
||||
{
|
||||
var v = new RecordingVariable(name, attr);
|
||||
@@ -398,10 +393,7 @@ public sealed class EquipmentNodeWalkerTests
|
||||
return v;
|
||||
}
|
||||
|
||||
/// <summary>Adds a property to the node.</summary>
|
||||
/// <param name="name">The browse name of the property.</param>
|
||||
/// <param name="_">The data type (unused).</param>
|
||||
/// <param name="value">The value of the property.</param>
|
||||
/// <inheritdoc />
|
||||
public void AddProperty(string name, DriverDataType _, object? value) =>
|
||||
Properties.Add(new RecordingProperty(name, value));
|
||||
}
|
||||
@@ -412,10 +404,9 @@ public sealed class EquipmentNodeWalkerTests
|
||||
/// <summary>Recorded variable for test verification.</summary>
|
||||
private sealed record RecordingVariable(string BrowseName, DriverAttributeInfo AttributeInfo) : IVariableHandle
|
||||
{
|
||||
/// <summary>Gets the full reference of the variable.</summary>
|
||||
/// <inheritdoc />
|
||||
public string FullReference => AttributeInfo.FullName;
|
||||
/// <summary>Marks the variable as an alarm condition.</summary>
|
||||
/// <param name="info">The alarm condition information.</param>
|
||||
/// <inheritdoc />
|
||||
public IAlarmConditionSink MarkAsAlarmCondition(AlarmConditionInfo info) => throw new NotSupportedException();
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user