Skip to content

Commit d1aed60

Browse files
committed
Update documentation in ChartOptions and ChartLayout
Improved clarity and consistency of documentation comments for properties in the `ChartOptions` and `ChartLayout` classes. Added `<para>` tags for better formatting, simplified descriptions, and explicitly stated default values. Refined `Description` attributes for clearer information. NOTE: This commit message is auto-generated using GitHub Copilot.
1 parent e0b0938 commit d1aed60

1 file changed

Lines changed: 38 additions & 20 deletions

File tree

BlazorExpress.ChartJS/Models/ChartOptions/ChartOptions.cs

Lines changed: 38 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ public interface IChartOptions { }
55
/// <summary>
66
/// Represents the base configuration options for all chart types.
77
/// <para>
8-
/// See <see href="https://www.chartjs.org/docs/latest/general/options.html" /> for more information.
8+
/// See <see href="https://www.chartjs.org/docs/latest/general/options.html" /> for more information.
99
/// </para>
1010
/// </summary>
1111
public class ChartOptions : IChartOptions
@@ -17,27 +17,31 @@ public class ChartOptions : IChartOptions
1717

1818
/// <summary>
1919
/// Gets or sets the locale for the chart.
20-
/// By default, the chart uses the default locale of the platform it is running on.
21-
/// </summary>
22-
/// <remarks>
20+
/// <para>
2321
/// Default value is <see langword="null" />.
24-
/// </remarks>
22+
/// </para>
23+
/// </summary>
2524
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
2625
[AddedVersion("1.0.0")]
2726
[DefaultValue(null)]
28-
[Description("Gets or sets the locale for the chart. By default, the chart uses the default locale of the platform it is running on.")]
27+
[Description("Gets or sets the locale for the chart.")]
28+
//[ParameterTypeName("string?")]
29+
[Parameter]
2930
public string? Locale { get; set; }
3031

3132
/// <summary>
3233
/// Gets or sets a value indicating whether to maintain the original canvas aspect ratio (width / height) when resizing.
33-
/// </summary>
34-
/// <remarks>
34+
/// <para>
3535
/// Default value is <see langword="true" />.
36-
/// See <see href="https://www.chartjs.org/docs/latest/configuration/responsive.html#configuration-options" />.
37-
/// </remarks>
36+
/// </para>
37+
/// <para>
38+
/// See <see href="https://www.chartjs.org/docs/latest/configuration/responsive.html#configuration-options" /> for more information.
39+
/// </para>
40+
/// </summary>
3841
[AddedVersion("1.0.0")]
3942
[DefaultValue(true)]
4043
[Description("Gets or sets a value indicating whether to maintain the original canvas aspect ratio (width / height) when resizing.")]
44+
[Parameter]
4145
public bool MaintainAspectRatio { get; set; } = true;
4246

4347
//onResize
@@ -48,38 +52,52 @@ public class ChartOptions : IChartOptions
4852

4953
/// <summary>
5054
/// Gets or sets a value indicating whether the chart canvas should resize when its container does.
51-
/// </summary>
52-
/// <remarks>
55+
/// <para>
5356
/// Default value is <see langword="true" />.
54-
/// See <see href="https://www.chartjs.org/docs/latest/configuration/responsive.html#configuration-options" />.
55-
/// </remarks>
57+
/// </para>
58+
/// <para>
59+
/// See <see href="https://www.chartjs.org/docs/latest/configuration/responsive.html#configuration-options" /> for more information.
60+
/// </para>
61+
/// </summary>
5662
[AddedVersion("1.0.0")]
5763
[DefaultValue(true)]
5864
[Description("Gets or sets a value indicating whether the chart canvas should resize when its container does.")]
65+
[Parameter]
5966
public bool Responsive { get; set; } = true;
6067

6168
#endregion
6269
}
6370

6471
/// <summary>
6572
/// Namespace: options.layout, the global options for the chart layout is defined in Chart.defaults.layout.
66-
/// <see href="https://www.chartjs.org/docs/latest/configuration/layout.html#layout" />.
73+
/// <see href="https://www.chartjs.org/docs/latest/configuration/layout.html#layout" /> for more information.
6774
/// </summary>
6875
public class ChartLayout
6976
{
7077
#region Properties, Indexers
7178

7279
/// <summary>
73-
/// Apply automatic padding so visible elements are completely drawn.
74-
/// </summary>
75-
/// <remarks>
80+
/// Gets or sets a value indicating whether to apply automatic padding so visible elements are completely drawn.
81+
/// <para>
7682
/// Default value is <see langword="true" />.
77-
/// </remarks>
83+
/// </para>
84+
/// </summary>
85+
[AddedVersion("1.0.0")]
86+
[DefaultValue(true)]
87+
[Description("Gets or sets a value indicating whether to apply automatic padding so visible elements are completely drawn.")]
88+
[Parameter]
7889
public bool AutoPadding { get; set; } = true;
7990

8091
/// <summary>
81-
/// The padding to add inside the chart.
92+
/// Gets or sets the padding to add inside the chart.
93+
/// <para>
94+
/// Default value is 0.
95+
/// </para>
8296
/// </summary>
97+
[AddedVersion("1.0.0")]
98+
[DefaultValue(0)]
99+
[Description("Gets or sets the padding to add inside the chart.")]
100+
[Parameter]
83101
public int Padding { get; set; } = 0;
84102

85103
#endregion

0 commit comments

Comments
 (0)