Documentation modifications

This commit is contained in:
julian
2026-06-27 15:23:26 -07:00
parent a633fe6c06
commit a19fb90902
218 changed files with 2882 additions and 0 deletions
@@ -7,10 +7,20 @@ namespace adas_core.Domain.Models;
/// </summary>
public class ObservatitonRetentionResult
{
/// <summary>
/// Initializes a new instance of the <see cref="ObservatitonRetentionResult"/> class, which represents the outcome of an observation retention operation.
/// </summary>
/// <!-- aidoc:v1 sig=4f5f5d1 body=4448e1d -->
public ObservatitonRetentionResult()
{
}
/// <summary>
/// Initializes a new instance of the <see cref="ObservatitonRetentionResult"/> class, which represents the outcome of a retention evaluation, by storing the supplied <paramref name="retentionPolicy"/> and its associated <paramref name="retentionPolicyValue"/>.
/// </summary>
/// <param name="retentionPolicy">The <see cref="RetentionPolicy"/> that was evaluated to produce the result.</param>
/// <param name="retentionPolicyValue">The optional numeric value paired with the <paramref name="retentionPolicy"/>, or <see langword="null"/> when no value is required.</param>
/// <!-- aidoc:v1 sig=d280e78 body=d032d9b -->
public ObservatitonRetentionResult(RetentionPolicy retentionPolicy, int? retentionPolicyValue)
{
RetentionPolicy = retentionPolicy;