Documentation modifications

2026-06-27 15:23:26 -07:00
parent a633fe6c06
commit a19fb90902
218 changed files with 2882 additions and 0 deletions
@@ -1,5 +1,14 @@
 namespace adas_core.Domain.Utils;

+/// <summary>
+/// Represents a sealed dictionary that inherits from <see cref="Dictionary{TKey,TValue}"/> and provides equality comparison with <see cref="ComparableDictionary{TKey,TValue}"/> instances through <see cref="IEquatable{T}"/>.
+/// </summary>
+/// <typeparam name="TKey">The type of the keys stored in the dictionary, constrained to be non-null.</typeparam>
+/// <typeparam name="TValue">The type of the values stored in the dictionary, constrained to be non-null.</typeparam>
+/// <remarks>
+/// The <see cref="IEquatable{T}"/> implementation targets <see cref="ComparableDictionary{TKey,TValue}"/> rather than the declaring <see cref="EquatableDictionary{TKey,TValue}"/> type, enabling cross-type equality semantics between the two dictionary variants.
+/// </remarks>
+/// <!-- aidoc:v1 sig=c2a0a45 -->
 public sealed class EquatableDictionary<TKey, TValue>
    : Dictionary<TKey, TValue>, IEquatable<ComparableDictionary<TKey, TValue>>
    where TKey : notnull where TValue : notnull