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
@@ -10,10 +10,28 @@ namespace adas_core.Domain.Models.GroupedObservations;
/// </remarks>
public class GroupedField
{
/// <summary>
/// Initializes a new default instance of the <see cref="GroupedField"/> class, representing a field that aggregates related items into a single addressable group.
/// </summary>
/// <!-- aidoc:v1 sig=703c28d body=4448e1d -->
public GroupedField()
{
}
/// <summary>
/// Initializes a new instance of <see cref="GroupedField"/>, which represents a configurable field for grouped observations with identifiers, scheduling offsets, and result selection.
/// Null collection parameters are normalized to empty lists, and <paramref name="result"/> defaults to a list containing <see cref="GroupedObservationEnum.Result.First"/> when omitted.
/// </summary>
/// <param name="name">The primary identifier of the field, or null when only the <paramref name="names"/> collection is used.</param>
/// <param name="names">The alternative identifiers for the field; when null, an empty <see cref="List{String}"/> is stored.</param>
/// <param name="group">The grouping key that associates the field with a logical group, or null if unspecified.</param>
/// <param name="startTimeShift">The list of schedule offsets applied to the field; when null, an empty <see cref="List{String}"/> is stored.</param>
/// <param name="max">The maximum number of observations retained for the field.</param>
/// <param name="regularity">The optional <see cref="GroupedObservationEnum.Regularity"/> that governs how observations are spaced.</param>
/// <param name="since">The <see cref="GroupedObservationEnum.Since"/> value that defines the schedule's starting reference.</param>
/// <param name="result">The list of <see cref="GroupedObservationEnum.Result"/> values the field should produce; when null, a list containing <see cref="GroupedObservationEnum.Result.First"/> is stored.</param>
/// <param name="labelList">The labels associated with the field, or null when no labels are provided.</param>
/// <!-- aidoc:v1 sig=8ca95e4 body=4742386 -->
public GroupedField(
string? name,
List<string>? names,