Skip to content

Commit 31a7c92

Browse files
committed
Enhance documentation and add BackgroundColor property
This commit introduces additional XML documentation comments for the `DoughnutChartDataset` class and its properties, including links to relevant Chart.js documentation for border alignment and border radius. A new `BackgroundColor` property is added to the `DoughnutChartDatasetData` record, allowing for background color customization. The `Circumference` property has been updated with comments related to clipping and documentation links. Various annotations such as `[AddedVersion("1.0.0")]`, `[DefaultValue(...)]`, and `[Description(...)]` have been added to improve overall documentation and usability. NOTE: This commit message is auto-generated using GitHub Copilot.
1 parent 971ed31 commit 31a7c92

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

BlazorExpress.ChartJS/Models/ChartDataset/DoughnutChart/DoughnutChartDataset.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ public class DoughnutChartDataset : ChartDataset<double?>
2929
/// <para>
3030
/// Default value is 'center'.
3131
/// </para>
32+
/// <see href="https://www.chartjs.org/docs/latest/charts/doughnut.html#border-alignment" />
3233
/// </summary>
3334
[AddedVersion("1.0.0")]
3435
[DefaultValue("center")]
@@ -94,6 +95,7 @@ public class DoughnutChartDataset : ChartDataset<double?>
9495
/// <para>
9596
/// Default value is 0.
9697
/// </para>
98+
/// <see href="https://www.chartjs.org/docs/latest/charts/doughnut.html#border-radius" />
9799
/// </summary>
98100
[AddedVersion("1.0.0")]
99101
[DefaultValue(0)]
@@ -128,6 +130,9 @@ public class DoughnutChartDataset : ChartDataset<double?>
128130
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
129131
public double? Circumference { get; set; }
130132

133+
//Clip
134+
//https://www.chartjs.org/docs/latest/charts/doughnut.html#general
135+
131136
[AddedVersion("1.0.0")]
132137
[DefaultValue("new()")]
133138
[Description("")]

BlazorExpress.ChartJS/Models/ChartDataset/DoughnutChart/DoughnutChartDatasetData.cs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,13 @@ public DoughnutChartDatasetData(string? datasetLabel, double data, string? backg
1313

1414
#region Properties, Indexers
1515

16+
/// <summary>
17+
/// Gets or initializes the background color as a string.
18+
/// </summary>
19+
[AddedVersion("1.0.0")]
20+
[DefaultValue(null)]
21+
[Description("")]
22+
[ParameterTypeName("string?")]
1623
public string? BackgroundColor { get; init; }
1724

1825
#endregion

0 commit comments

Comments
 (0)