Skip to content

Commit 102b167

Browse files
gvreddy04gvreddy04
committed
Update package versions and enhance method documentation
Updated the version numbers of the `BlazorExpress.Bulma` and `BlazorExpress.Bulma.Docx` packages in the `BlazorExpress.ChartJS.Demo.RCL.csproj` file from `0.1.0` to `0.1.1` and from `0.2.0` to `0.2.1`, respectively. Also updated the version number of the `BlazorExpress.Core` package in the `BlazorExpress.ChartJS.csproj` file from `0.1.0` to `0.1.1`. Added the `MethodReturnTypeName` attribute to several asynchronous methods in the `BarChart`, `DoughnutChart`, `LineChart`, `PieChart`, `PolarAreaChart`, `RadarChart`, and `ScatterChart` classes, enhancing the documentation by specifying the return type of the methods. NOTE: This commit message is auto-generated using GitHub Copilot.
1 parent 390a0a6 commit 102b167

9 files changed

Lines changed: 38 additions & 3 deletions

File tree

‎BlazorExpress.ChartJS.Demo.RCL/BlazorExpress.ChartJS.Demo.RCL.csproj‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@
2424
</ItemGroup>
2525

2626
<ItemGroup>
27-
<PackageReference Include="BlazorExpress.Bulma" Version="0.1.0" />
28-
<PackageReference Include="BlazorExpress.Bulma.Docx" Version="0.2.0" />
27+
<PackageReference Include="BlazorExpress.Bulma" Version="0.1.1" />
28+
<PackageReference Include="BlazorExpress.Bulma.Docx" Version="0.2.1" />
2929
<PackageReference Include="Microsoft.AspNetCore.Components.Web" Version="8.0.17" />
3030
<PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="8.0.0" />
3131
</ItemGroup>

‎BlazorExpress.ChartJS/BlazorExpress.ChartJS.csproj‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
</ItemGroup>
3333

3434
<ItemGroup>
35-
<PackageReference Include="BlazorExpress.Core" Version="0.1.0" />
35+
<PackageReference Include="BlazorExpress.Core" Version="0.1.1" />
3636
<PackageReference Include="Microsoft.AspNetCore.Components.Web" Version="8.0.17" />
3737
</ItemGroup>
3838

‎BlazorExpress.ChartJS/ChartComponents/BarChart.razor.cs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ public BarChart()
2222
/// <returns>A task representing the asynchronous operation, with a result of the updated <see cref="ChartData"/>.</returns>
2323
[AddedVersion("1.0.0")]
2424
[Description("Asynchronously adds a new data entry to the specified chart data.")]
25+
[MethodReturnTypeName($"Task<{nameof(ChartData)}>")]
2526
public override async Task<ChartData> AddDataAsync(ChartData chartData, string dataLabel, IChartDatasetData data)
2627
{
2728
if (chartData is null)
@@ -53,6 +54,7 @@ public override async Task<ChartData> AddDataAsync(ChartData chartData, string d
5354
/// dataset added.</returns>
5455
[AddedVersion("1.0.0")]
5556
[Description("Asynchronously adds a new dataset to the specified chart data.")]
57+
[MethodReturnTypeName($"Task<{nameof(ChartData)}>")]
5658
public override async Task<ChartData> AddDataAsync(ChartData chartData, string dataLabel, IReadOnlyCollection<IChartDatasetData> data)
5759
{
5860
if (chartData is null)
@@ -108,6 +110,7 @@ public override async Task<ChartData> AddDataAsync(ChartData chartData, string d
108110
/// dataset added.</returns>
109111
[AddedVersion("1.0.0")]
110112
[Description("Asynchronously adds a dataset to the specified chart data.")]
113+
[MethodReturnTypeName($"Task<{nameof(ChartData)}>")]
111114
public override async Task<ChartData> AddDatasetAsync(ChartData chartData, IChartDataset chartDataset, IChartOptions chartOptions)
112115
{
113116
if (chartData is null)
@@ -140,6 +143,7 @@ public override async Task<ChartData> AddDatasetAsync(ChartData chartData, IChar
140143
/// <returns>A task that represents the asynchronous initialization operation.</returns>
141144
[AddedVersion("1.0.0")]
142145
[Description("Asynchronously initializes the chart with the specified data and options.")]
146+
[MethodReturnTypeName(nameof(Task))]
143147
public override async Task InitializeAsync(ChartData chartData, IChartOptions chartOptions, string[]? plugins = null)
144148
{
145149
if (chartData is not null && chartData.Datasets is not null)
@@ -160,6 +164,7 @@ public override async Task InitializeAsync(ChartData chartData, IChartOptions ch
160164
/// <returns></returns>
161165
[AddedVersion("1.0.0")]
162166
[Description("Asynchronously updates the chart with the specified data and options.")]
167+
[MethodReturnTypeName(nameof(Task))]
163168
public override async Task UpdateAsync(ChartData chartData, IChartOptions chartOptions)
164169
{
165170
if (chartData is not null && chartData.Datasets is not null)

‎BlazorExpress.ChartJS/ChartComponents/DoughnutChart.razor.cs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ public DoughnutChart()
2222
/// <returns>A task representing the asynchronous operation, with a result of the updated <see cref="ChartData"/>.</returns>
2323
[AddedVersion("1.0.0")]
2424
[Description("Asynchronously adds a new data entry to the specified chart data.")]
25+
[MethodReturnTypeName($"Task<{nameof(ChartData)}>")]
2526
public override async Task<ChartData> AddDataAsync(ChartData chartData, string dataLabel, IChartDatasetData data)
2627
{
2728
if (chartData is null)
@@ -56,6 +57,7 @@ public override async Task<ChartData> AddDataAsync(ChartData chartData, string d
5657
/// dataset added.</returns>
5758
[AddedVersion("1.0.0")]
5859
[Description("Asynchronously adds a new dataset to the specified chart data.")]
60+
[MethodReturnTypeName($"Task<{nameof(ChartData)}>")]
5961
public override async Task<ChartData> AddDataAsync(ChartData chartData, string dataLabel, IReadOnlyCollection<IChartDatasetData> data)
6062
{
6163
if (chartData is null)
@@ -114,6 +116,7 @@ public override async Task<ChartData> AddDataAsync(ChartData chartData, string d
114116
/// dataset added.</returns>
115117
[AddedVersion("1.0.0")]
116118
[Description("Asynchronously adds a dataset to the specified chart data.")]
119+
[MethodReturnTypeName($"Task<{nameof(ChartData)}>")]
117120
public override async Task<ChartData> AddDatasetAsync(ChartData chartData, IChartDataset chartDataset, IChartOptions chartOptions)
118121
{
119122
if (chartData is null)
@@ -146,6 +149,7 @@ public override async Task<ChartData> AddDatasetAsync(ChartData chartData, IChar
146149
/// <returns>A task that represents the asynchronous initialization operation.</returns>
147150
[AddedVersion("1.0.0")]
148151
[Description("Asynchronously initializes the chart with the specified data and options.")]
152+
[MethodReturnTypeName(nameof(Task))]
149153
public override async Task InitializeAsync(ChartData chartData, IChartOptions chartOptions, string[]? plugins = null)
150154
{
151155
if (chartData is not null && chartData.Datasets is not null)
@@ -166,6 +170,7 @@ public override async Task InitializeAsync(ChartData chartData, IChartOptions ch
166170
/// <returns></returns>
167171
[AddedVersion("1.0.0")]
168172
[Description("Asynchronously updates the chart with the specified data and options.")]
173+
[MethodReturnTypeName(nameof(Task))]
169174
public override async Task UpdateAsync(ChartData chartData, IChartOptions chartOptions)
170175
{
171176
if (chartData is not null && chartData.Datasets is not null)

‎BlazorExpress.ChartJS/ChartComponents/LineChart.razor.cs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ public LineChart()
2222
/// <returns>A task representing the asynchronous operation, with a result of the updated <see cref="ChartData"/>.</returns>
2323
[AddedVersion("1.0.0")]
2424
[Description("Asynchronously adds a new data entry to the specified chart data.")]
25+
[MethodReturnTypeName($"Task<{nameof(ChartData)}>")]
2526
public override async Task<ChartData> AddDataAsync(ChartData chartData, string dataLabel, IChartDatasetData data)
2627
{
2728
if (chartData is null)
@@ -53,6 +54,7 @@ public override async Task<ChartData> AddDataAsync(ChartData chartData, string d
5354
/// dataset added.</returns>
5455
[AddedVersion("1.0.0")]
5556
[Description("Asynchronously adds a new dataset to the specified chart data.")]
57+
[MethodReturnTypeName($"Task<{nameof(ChartData)}>")]
5658
public override async Task<ChartData> AddDataAsync(ChartData chartData, string dataLabel, IReadOnlyCollection<IChartDatasetData> data)
5759
{
5860
if (chartData is null)
@@ -108,6 +110,7 @@ public override async Task<ChartData> AddDataAsync(ChartData chartData, string d
108110
/// dataset added.</returns>
109111
[AddedVersion("1.0.0")]
110112
[Description("Asynchronously adds a dataset to the specified chart data.")]
113+
[MethodReturnTypeName($"Task<{nameof(ChartData)}>")]
111114
public override async Task<ChartData> AddDatasetAsync(ChartData chartData, IChartDataset chartDataset, IChartOptions chartOptions)
112115
{
113116
if (chartData is null)
@@ -140,6 +143,7 @@ public override async Task<ChartData> AddDatasetAsync(ChartData chartData, IChar
140143
/// <returns>A task that represents the asynchronous initialization operation.</returns>
141144
[AddedVersion("1.0.0")]
142145
[Description("Asynchronously initializes the chart with the specified data and options.")]
146+
[MethodReturnTypeName(nameof(Task))]
143147
public override async Task InitializeAsync(ChartData chartData, IChartOptions chartOptions, string[]? plugins = null)
144148
{
145149
if (chartData is null)
@@ -166,6 +170,7 @@ public override async Task InitializeAsync(ChartData chartData, IChartOptions ch
166170
/// <returns></returns>
167171
[AddedVersion("1.0.0")]
168172
[Description("Asynchronously updates the chart with the specified data and options.")]
173+
[MethodReturnTypeName(nameof(Task))]
169174
public override async Task UpdateAsync(ChartData chartData, IChartOptions chartOptions)
170175
{
171176
if (chartData is null)

‎BlazorExpress.ChartJS/ChartComponents/PieChart.razor.cs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ public PieChart()
2222
/// <returns>A task representing the asynchronous operation, with a result of the updated <see cref="ChartData"/>.</returns>
2323
[AddedVersion("1.0.0")]
2424
[Description("Asynchronously adds a new data entry to the specified chart data.")]
25+
[MethodReturnTypeName($"Task<{nameof(ChartData)}>")]
2526
public override async Task<ChartData> AddDataAsync(ChartData chartData, string dataLabel, IChartDatasetData data)
2627
{
2728
if (chartData is null)
@@ -56,6 +57,7 @@ public override async Task<ChartData> AddDataAsync(ChartData chartData, string d
5657
/// dataset added.</returns>
5758
[AddedVersion("1.0.0")]
5859
[Description("Asynchronously adds a new dataset to the specified chart data.")]
60+
[MethodReturnTypeName($"Task<{nameof(ChartData)}>")]
5961
public override async Task<ChartData> AddDataAsync(ChartData chartData, string dataLabel, IReadOnlyCollection<IChartDatasetData> data)
6062
{
6163
if (chartData is null)
@@ -114,6 +116,7 @@ public override async Task<ChartData> AddDataAsync(ChartData chartData, string d
114116
/// dataset added.</returns>
115117
[AddedVersion("1.0.0")]
116118
[Description("Asynchronously adds a dataset to the specified chart data.")]
119+
[MethodReturnTypeName($"Task<{nameof(ChartData)}>")]
117120
public override async Task<ChartData> AddDatasetAsync(ChartData chartData, IChartDataset chartDataset, IChartOptions chartOptions)
118121
{
119122
if (chartData is null)
@@ -146,6 +149,7 @@ public override async Task<ChartData> AddDatasetAsync(ChartData chartData, IChar
146149
/// <returns>A task that represents the asynchronous initialization operation.</returns>
147150
[AddedVersion("1.0.0")]
148151
[Description("Asynchronously initializes the chart with the specified data and options.")]
152+
[MethodReturnTypeName(nameof(Task))]
149153
public override async Task InitializeAsync(ChartData chartData, IChartOptions chartOptions, string[]? plugins = null)
150154
{
151155
if (chartData is not null && chartData.Datasets is not null)
@@ -166,6 +170,7 @@ public override async Task InitializeAsync(ChartData chartData, IChartOptions ch
166170
/// <returns></returns>
167171
[AddedVersion("1.0.0")]
168172
[Description("Asynchronously updates the chart with the specified data and options.")]
173+
[MethodReturnTypeName(nameof(Task))]
169174
public override async Task UpdateAsync(ChartData chartData, IChartOptions chartOptions)
170175
{
171176
if (chartData is not null && chartData.Datasets is not null)

‎BlazorExpress.ChartJS/ChartComponents/PolarAreaChart.razor.cs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ public PolarAreaChart()
2222
/// <returns>A task representing the asynchronous operation, with a result of the updated <see cref="ChartData"/>.</returns>
2323
[AddedVersion("1.0.0")]
2424
[Description("Asynchronously adds a new data entry to the specified chart data.")]
25+
[MethodReturnTypeName($"Task<{nameof(ChartData)}>")]
2526
public override async Task<ChartData> AddDataAsync(ChartData chartData, string dataLabel, IChartDatasetData data)
2627
{
2728
if (chartData is null)
@@ -53,6 +54,7 @@ public override async Task<ChartData> AddDataAsync(ChartData chartData, string d
5354
/// dataset added.</returns>
5455
[AddedVersion("1.0.0")]
5556
[Description("Asynchronously adds a new dataset to the specified chart data.")]
57+
[MethodReturnTypeName($"Task<{nameof(ChartData)}>")]
5658
public override async Task<ChartData> AddDataAsync(ChartData chartData, string dataLabel, IReadOnlyCollection<IChartDatasetData> data)
5759
{
5860
if (chartData is null)
@@ -108,6 +110,7 @@ public override async Task<ChartData> AddDataAsync(ChartData chartData, string d
108110
/// dataset added.</returns>
109111
[AddedVersion("1.0.0")]
110112
[Description("Asynchronously adds a dataset to the specified chart data.")]
113+
[MethodReturnTypeName($"Task<{nameof(ChartData)}>")]
111114
public override async Task<ChartData> AddDatasetAsync(ChartData chartData, IChartDataset chartDataset, IChartOptions chartOptions)
112115
{
113116
if (chartData is null)
@@ -140,6 +143,7 @@ public override async Task<ChartData> AddDatasetAsync(ChartData chartData, IChar
140143
/// <returns>A task that represents the asynchronous initialization operation.</returns>
141144
[AddedVersion("1.0.0")]
142145
[Description("Asynchronously initializes the chart with the specified data and options.")]
146+
[MethodReturnTypeName(nameof(Task))]
143147
public override async Task InitializeAsync(ChartData chartData, IChartOptions chartOptions, string[]? plugins = null)
144148
{
145149
if (chartData is not null && chartData.Datasets is not null)
@@ -160,6 +164,7 @@ public override async Task InitializeAsync(ChartData chartData, IChartOptions ch
160164
/// <returns></returns>
161165
[AddedVersion("1.0.0")]
162166
[Description("Asynchronously updates the chart with the specified data and options.")]
167+
[MethodReturnTypeName(nameof(Task))]
163168
public override async Task UpdateAsync(ChartData chartData, IChartOptions chartOptions)
164169
{
165170
if (chartData is not null && chartData.Datasets is not null)

‎BlazorExpress.ChartJS/ChartComponents/RadarChart.razor.cs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ public RadarChart()
2222
/// <returns>A task representing the asynchronous operation, with a result of the updated <see cref="ChartData"/>.</returns>
2323
[AddedVersion("1.0.0")]
2424
[Description("Asynchronously adds a new data entry to the specified chart data.")]
25+
[MethodReturnTypeName($"Task<{nameof(ChartData)}>")]
2526
public override async Task<ChartData> AddDataAsync(ChartData chartData, string dataLabel, IChartDatasetData data) // TODO: May be this method is not required
2627
{
2728
if (chartData is null)
@@ -53,6 +54,7 @@ public override async Task<ChartData> AddDataAsync(ChartData chartData, string d
5354
/// dataset added.</returns>
5455
[AddedVersion("1.0.0")]
5556
[Description("Asynchronously adds a new dataset to the specified chart data.")]
57+
[MethodReturnTypeName($"Task<{nameof(ChartData)}>")]
5658
public override async Task<ChartData> AddDataAsync(ChartData chartData, string dataLabel, IReadOnlyCollection<IChartDatasetData> data)
5759
{
5860
if (chartData is null)
@@ -108,6 +110,7 @@ public override async Task<ChartData> AddDataAsync(ChartData chartData, string d
108110
/// dataset added.</returns>
109111
[AddedVersion("1.0.0")]
110112
[Description("Asynchronously adds a dataset to the specified chart data.")]
113+
[MethodReturnTypeName($"Task<{nameof(ChartData)}>")]
111114
public override async Task<ChartData> AddDatasetAsync(ChartData chartData, IChartDataset chartDataset, IChartOptions chartOptions)
112115
{
113116
if (chartData is null)
@@ -140,6 +143,7 @@ public override async Task<ChartData> AddDatasetAsync(ChartData chartData, IChar
140143
/// <returns>A task that represents the asynchronous initialization operation.</returns>
141144
[AddedVersion("1.0.0")]
142145
[Description("Asynchronously initializes the chart with the specified data and options.")]
146+
[MethodReturnTypeName(nameof(Task))]
143147
public override async Task InitializeAsync(ChartData chartData, IChartOptions chartOptions, string[]? plugins = null)
144148
{
145149
if (chartData is not null && chartData.Datasets is not null)
@@ -160,6 +164,7 @@ public override async Task InitializeAsync(ChartData chartData, IChartOptions ch
160164
/// <returns></returns>
161165
[AddedVersion("1.0.0")]
162166
[Description("Asynchronously updates the chart with the specified data and options.")]
167+
[MethodReturnTypeName(nameof(Task))]
163168
public override async Task UpdateAsync(ChartData chartData, IChartOptions chartOptions)
164169
{
165170
if (chartData is not null && chartData.Datasets is not null)

‎BlazorExpress.ChartJS/ChartComponents/ScatterChart.razor.cs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ public ScatterChart()
2222
/// <returns>A task representing the asynchronous operation, with a result of the updated <see cref="ChartData"/>.</returns>
2323
[AddedVersion("1.0.0")]
2424
[Description("Asynchronously adds a new data entry to the specified chart data.")]
25+
[MethodReturnTypeName($"Task<{nameof(ChartData)}>")]
2526
public override async Task<ChartData> AddDataAsync(ChartData chartData, string dataLabel, IChartDatasetData data) // TODO: May be this method is not required
2627
{
2728
if (chartData is null)
@@ -53,6 +54,7 @@ public override async Task<ChartData> AddDataAsync(ChartData chartData, string d
5354
/// dataset added.</returns>
5455
[AddedVersion("1.0.0")]
5556
[Description("Asynchronously adds a new dataset to the specified chart data.")]
57+
[MethodReturnTypeName($"Task<{nameof(ChartData)}>")]
5658
public override async Task<ChartData> AddDataAsync(ChartData chartData, string dataLabel, IReadOnlyCollection<IChartDatasetData> data)
5759
{
5860
if (chartData is null)
@@ -108,6 +110,7 @@ public override async Task<ChartData> AddDataAsync(ChartData chartData, string d
108110
/// dataset added.</returns>
109111
[AddedVersion("1.0.0")]
110112
[Description("Asynchronously adds a dataset to the specified chart data.")]
113+
[MethodReturnTypeName($"Task<{nameof(ChartData)}>")]
111114
public override async Task<ChartData> AddDatasetAsync(ChartData chartData, IChartDataset chartDataset, IChartOptions chartOptions)
112115
{
113116
if (chartData is null)
@@ -140,6 +143,7 @@ public override async Task<ChartData> AddDatasetAsync(ChartData chartData, IChar
140143
/// <returns>A task that represents the asynchronous initialization operation.</returns>
141144
[AddedVersion("1.0.0")]
142145
[Description("Asynchronously initializes the chart with the specified data and options.")]
146+
[MethodReturnTypeName(nameof(Task))]
143147
public override async Task InitializeAsync(ChartData chartData, IChartOptions chartOptions, string[]? plugins = null)
144148
{
145149
if (chartData is null)
@@ -166,6 +170,7 @@ public override async Task InitializeAsync(ChartData chartData, IChartOptions ch
166170
/// <returns></returns>
167171
[AddedVersion("1.0.0")]
168172
[Description("Asynchronously updates the chart with the specified data and options.")]
173+
[MethodReturnTypeName(nameof(Task))]
169174
public override async Task UpdateAsync(ChartData chartData, IChartOptions chartOptions)
170175
{
171176
if (chartData is null)

0 commit comments

Comments
 (0)