Skip to content

Commit b538fb1

Browse files
ArgoZhangArgoZhang
authored
doc(Filter): update inherit documentation (#7739)
1 parent 0db420d commit b538fb1

12 files changed

+54
-73
lines changed

‎src/BootstrapBlazor/Components/Filters/BoolFilter.razor.cs‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ public partial class BoolFilter
2121
private string _value = "";
2222

2323
/// <summary>
24-
/// <para lang="zh"><inheritdoc/></para>
25-
/// <para lang="en"><inheritdoc/></para>
24+
/// <inheritdoc/>
2625
/// </summary>
2726
protected override void OnParametersSet()
2827
{
@@ -37,8 +36,7 @@ protected override void OnParametersSet()
3736
}
3837

3938
/// <summary>
40-
/// <para lang="zh"><inheritdoc/></para>
41-
/// <para lang="en"><inheritdoc/></para>
39+
/// <inheritdoc cref="IFilterAction.Reset"/>
4240
/// </summary>
4341
public override void Reset()
4442
{
@@ -47,8 +45,7 @@ public override void Reset()
4745
}
4846

4947
/// <summary>
50-
/// <para lang="zh"><inheritdoc/></para>
51-
/// <para lang="en"><inheritdoc/></para>
48+
/// <inheritdoc cref="IFilterAction.GetFilterConditions"/>
5249
/// </summary>
5350
public override FilterKeyValueAction GetFilterConditions()
5451
{
@@ -66,8 +63,7 @@ public override FilterKeyValueAction GetFilterConditions()
6663
}
6764

6865
/// <summary>
69-
/// <para lang="zh"><inheritdoc/></para>
70-
/// <para lang="en"><inheritdoc/></para>
66+
/// <inheritdoc cref="IFilterAction.SetFilterConditionsAsync(FilterKeyValueAction)"/>
7167
/// </summary>
7268
public override async Task SetFilterConditionsAsync(FilterKeyValueAction filter)
7369
{

‎src/BootstrapBlazor/Components/Filters/DateTimeFilter.razor.cs‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ public partial class DateTimeFilter
2828
public IEnumerable<SelectedItem>? Items { get; set; }
2929

3030
/// <summary>
31-
/// <para lang="zh"><inheritdoc/></para>
32-
/// <para lang="en"><inheritdoc/></para>
31+
/// <inheritdoc/>
3332
/// </summary>
3433
protected override void OnParametersSet()
3534
{
@@ -47,8 +46,7 @@ protected override void OnParametersSet()
4746
}
4847

4948
/// <summary>
50-
/// <para lang="zh"><inheritdoc/></para>
51-
/// <para lang="en"><inheritdoc/></para>
49+
/// <inheritdoc cref="IFilterAction.Reset"/>
5250
/// </summary>
5351
public override void Reset()
5452
{
@@ -62,8 +60,7 @@ public override void Reset()
6260
}
6361

6462
/// <summary>
65-
/// <para lang="zh"><inheritdoc/></para>
66-
/// <para lang="en"><inheritdoc/></para>
63+
/// <inheritdoc cref="IFilterAction.GetFilterConditions"/>
6764
/// </summary>
6865
public override FilterKeyValueAction GetFilterConditions()
6966
{
@@ -92,8 +89,7 @@ public override FilterKeyValueAction GetFilterConditions()
9289
}
9390

9491
/// <summary>
95-
/// <para lang="zh"><inheritdoc/></para>
96-
/// <para lang="en"><inheritdoc/></para>
92+
/// <inheritdoc cref="IFilterAction.SetFilterConditionsAsync(FilterKeyValueAction)"/>
9793
/// </summary>
9894
public override async Task SetFilterConditionsAsync(FilterKeyValueAction filter)
9995
{

‎src/BootstrapBlazor/Components/Filters/EnumFilter.razor.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ protected override void OnParametersSet()
4747
}
4848

4949
/// <summary>
50-
/// <inheritdoc/>
50+
/// <inheritdoc cref="IFilterAction.Reset"/>
5151
/// </summary>
5252
public override void Reset()
5353
{
@@ -58,7 +58,7 @@ public override void Reset()
5858
}
5959

6060
/// <summary>
61-
/// <inheritdoc/>
61+
/// <inheritdoc cref="IFilterAction.GetFilterConditions"/>
6262
/// </summary>
6363
public override FilterKeyValueAction GetFilterConditions()
6464
{
@@ -87,7 +87,7 @@ public override FilterKeyValueAction GetFilterConditions()
8787
}
8888

8989
/// <summary>
90-
/// <inheritdoc/>
90+
/// <inheritdoc cref="IFilterAction.SetFilterConditionsAsync(FilterKeyValueAction)"/>
9191
/// </summary>
9292
public override async Task SetFilterConditionsAsync(FilterKeyValueAction filter)
9393
{

‎src/BootstrapBlazor/Components/Filters/FilterBase.cs‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -120,20 +120,17 @@ protected virtual async Task OnFilterAsync()
120120
}
121121

122122
/// <summary>
123-
/// <para lang="zh">重置过滤条件方法</para>
124-
/// <para lang="en">Reset Filter Conditions Method</para>
123+
/// <inheritdoc cref="IFilterAction.Reset"/>
125124
/// </summary>
126125
public abstract void Reset();
127126

128127
/// <summary>
129-
/// <para lang="zh">获得过滤窗口的所有条件的方法</para>
130-
/// <para lang="en">Gets all filter conditions</para>
128+
/// <inheritdoc cref="IFilterAction.GetFilterConditions"/>
131129
/// </summary>
132130
public abstract FilterKeyValueAction GetFilterConditions();
133131

134132
/// <summary>
135-
/// <para lang="zh">设置过滤集合的方法</para>
136-
/// <para lang="en">Sets the filter collection</para>
133+
/// <inheritdoc cref="IFilterAction.SetFilterConditionsAsync(FilterKeyValueAction)"/>
137134
/// </summary>
138135
/// <param name="filter"></param>
139136
public virtual Task SetFilterConditionsAsync(FilterKeyValueAction filter) => OnFilterAsync();

‎src/BootstrapBlazor/Components/Filters/LookupFilter.razor.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ protected override async Task OnParametersSetAsync()
4646
}
4747

4848
/// <summary>
49-
/// <inheritdoc/>
49+
/// <inheritdoc cref="IFilterAction.Reset"/>
5050
/// </summary>
5151
public override void Reset()
5252
{
@@ -55,7 +55,7 @@ public override void Reset()
5555
}
5656

5757
/// <summary>
58-
/// <inheritdoc/>
58+
/// <inheritdoc cref="IFilterAction.GetFilterConditions"/>
5959
/// </summary>
6060
public override FilterKeyValueAction GetFilterConditions()
6161
{
@@ -75,7 +75,7 @@ public override FilterKeyValueAction GetFilterConditions()
7575
}
7676

7777
/// <summary>
78-
/// <inheritdoc/>
78+
/// <inheritdoc cref="IFilterAction.SetFilterConditionsAsync(FilterKeyValueAction)"/>
7979
/// </summary>
8080
public override async Task SetFilterConditionsAsync(FilterKeyValueAction filter)
8181
{

‎src/BootstrapBlazor/Components/Filters/MultiFilter.razor.cs‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -208,8 +208,7 @@ private Task OnSearchValueChanged(string? val)
208208
private List<SelectedItem> GetItems() => _items ?? _source ?? [];
209209

210210
/// <summary>
211-
/// <para lang="zh">重置过滤条件方法</para>
212-
/// <para lang="en">Reset Filter Conditions Method</para>
211+
/// <inheritdoc cref="IFilterAction.Reset"/>
213212
/// </summary>
214213
public override void Reset()
215214
{
@@ -226,8 +225,7 @@ public override void Reset()
226225
}
227226

228227
/// <summary>
229-
/// <para lang="zh">生成过滤条件方法</para>
230-
/// <para lang="en">Generate Filter Conditions Method</para>
228+
/// <inheritdoc cref="IFilterAction.GetFilterConditions"/>
231229
/// </summary>
232230
public override FilterKeyValueAction GetFilterConditions()
233231
{
@@ -245,7 +243,7 @@ public override FilterKeyValueAction GetFilterConditions()
245243
}
246244

247245
/// <summary>
248-
/// <inheritdoc/>
246+
/// <inheritdoc cref="IFilterAction.SetFilterConditionsAsync(FilterKeyValueAction)"/>
249247
/// </summary>
250248
/// <param name="filter"></param>
251249
public override async Task SetFilterConditionsAsync(FilterKeyValueAction filter)

‎src/BootstrapBlazor/Components/Filters/MultiSelectFilter.razor.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public partial class MultiSelectFilter<TType>
2626
public List<SelectedItem>? Items { get; set; }
2727

2828
/// <summary>
29-
/// <inheritdoc/>
29+
/// <inheritdoc cref="IFilterAction.Reset"/>
3030
/// </summary>
3131
public override void Reset()
3232
{
@@ -37,7 +37,7 @@ public override void Reset()
3737
}
3838

3939
/// <summary>
40-
/// <inheritdoc/>
40+
/// <inheritdoc cref="IFilterAction.GetFilterConditions"/>
4141
/// </summary>
4242
public override FilterKeyValueAction GetFilterConditions()
4343
{
@@ -71,7 +71,7 @@ public override FilterKeyValueAction GetFilterConditions()
7171
}
7272

7373
/// <summary>
74-
/// <inheritdoc/>
74+
/// <inheritdoc cref="IFilterAction.SetFilterConditionsAsync(FilterKeyValueAction)"/>
7575
/// </summary>
7676
public override async Task SetFilterConditionsAsync(FilterKeyValueAction filter)
7777
{

‎src/BootstrapBlazor/Components/Filters/NotSupportFilter.razor.cs‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,18 @@ protected override void OnParametersSet()
3030
}
3131

3232
/// <summary>
33-
/// <inheritdoc/>
33+
/// <inheritdoc cref="IFilterAction.Reset"/>
3434
/// </summary>
35-
public override FilterKeyValueAction GetFilterConditions()
35+
public override void Reset()
3636
{
37-
return new();
37+
3838
}
3939

4040
/// <summary>
41-
/// <inheritdoc/>
41+
/// <inheritdoc cref="IFilterAction.GetFilterConditions"/>
4242
/// </summary>
43-
public override void Reset()
43+
public override FilterKeyValueAction GetFilterConditions()
4444
{
45-
45+
return new();
4646
}
4747
}

‎src/BootstrapBlazor/Components/Filters/NumberFilter.razor.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ protected override void OnParametersSet()
4848
}
4949

5050
/// <summary>
51-
/// <inheritdoc/>
51+
/// <inheritdoc cref="IFilterAction.Reset"/>
5252
/// </summary>
5353
public override void Reset()
5454
{
@@ -62,7 +62,7 @@ public override void Reset()
6262
}
6363

6464
/// <summary>
65-
/// <inheritdoc/>
65+
/// <inheritdoc cref="IFilterAction.GetFilterConditions"/>
6666
/// </summary>
6767
public override FilterKeyValueAction GetFilterConditions()
6868
{
@@ -91,7 +91,7 @@ public override FilterKeyValueAction GetFilterConditions()
9191
}
9292

9393
/// <summary>
94-
/// <inheritdoc/>
94+
/// <inheritdoc cref="IFilterAction.SetFilterConditionsAsync(FilterKeyValueAction)"/>
9595
/// </summary>
9696
public override async Task SetFilterConditionsAsync(FilterKeyValueAction filter)
9797
{

‎src/BootstrapBlazor/Components/Filters/SearchFilterAction.cs‎

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -33,17 +33,25 @@ public class SearchFilterAction(string name, object? value, FilterAction action
3333
public FilterAction Action { get; set; } = action;
3434

3535
/// <summary>
36-
/// <para lang="zh">重置过滤条件方法</para>
37-
/// <para lang="en">Resets filter conditions</para>
36+
/// <inheritdoc cref="IFilterAction.Reset"/>
3837
/// </summary>
3938
public void Reset()
4039
{
4140
Value = null;
4241
}
4342

4443
/// <summary>
45-
/// <para lang="zh">设置过滤条件方法</para>
46-
/// <para lang="en">Sets filter conditions</para>
44+
/// <inheritdoc cref="IFilterAction.GetFilterConditions"/>
45+
/// </summary>
46+
public virtual FilterKeyValueAction GetFilterConditions() => new()
47+
{
48+
FieldKey = Name,
49+
FieldValue = Value,
50+
FilterAction = Action,
51+
};
52+
53+
/// <summary>
54+
/// <inheritdoc cref="IFilterAction.SetFilterConditionsAsync(FilterKeyValueAction)"/>
4755
/// </summary>
4856
/// <param name="filter"></param>
4957
public Task SetFilterConditionsAsync(FilterKeyValueAction filter)
@@ -55,15 +63,4 @@ public Task SetFilterConditionsAsync(FilterKeyValueAction filter)
5563
}
5664
return Task.CompletedTask;
5765
}
58-
59-
/// <summary>
60-
/// <para lang="zh">获得 所有过滤条件集合</para>
61-
/// <para lang="en">Gets all filter conditions</para>
62-
/// </summary>
63-
public virtual FilterKeyValueAction GetFilterConditions() => new()
64-
{
65-
FieldKey = Name,
66-
FieldValue = Value,
67-
FilterAction = Action,
68-
};
6966
}

0 commit comments

Comments
 (0)