Achieves 100% XML doc coverage on non-trivial types with CS1591 enforcement via Directory.Build.props. Coverage by project: - Butter: from 6.5% to 100% (DTOs, enums, MIME types) - Lactose: from ~28% to 100% (controllers, services, repos, jobs, models) - MilkStream.Client: from ~29% to 100% (all frontend services) Uses <inheritdoc /> on repository implementations (interfaces already documented) and full <summary>/<param>/<returns> tags elsewhere. Enums include member-level docs.
34 lines
1.1 KiB
C#
34 lines
1.1 KiB
C#
using Butter.Settings;
|
|
|
|
namespace Butter.Dtos.Settings;
|
|
|
|
/// <summary>
|
|
/// Represents an application setting with its value, type, and display configuration.
|
|
/// </summary>
|
|
public class SettingDto {
|
|
/// <summary>
|
|
/// Gets or sets the name of the setting.
|
|
/// </summary>
|
|
public required string Name { get; set; } = string.Empty;
|
|
/// <summary>
|
|
/// Gets or sets the current value of the setting.
|
|
/// </summary>
|
|
public string? Value { get; set; } = string.Empty;
|
|
/// <summary>
|
|
/// Gets or sets the description of the setting.
|
|
/// </summary>
|
|
public required string? Description { get; set; }
|
|
/// <summary>
|
|
/// Gets or sets the data type of the setting value.
|
|
/// </summary>
|
|
public required EType Type { get; set; }
|
|
/// <summary>
|
|
/// Gets or sets how the setting should be displayed in the UI.
|
|
/// </summary>
|
|
public required DisplayType DisplayType { get; set; }
|
|
/// <summary>
|
|
/// Gets or sets the available options for the setting (for range types: min, max, step).
|
|
/// </summary>
|
|
public string[]? Options { get; set; }
|
|
}
|