Skip to content

Commit 0ee1538

Browse files
authored
doc(Components): update comments for component (#7552)
* doc: 更新注释文档 * doc: 更新文档注释 * doc: 更新注释文档
1 parent b001477 commit 0ee1538

523 files changed

Lines changed: 2030 additions & 5602 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

exclusion.dic

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,3 +125,4 @@ alertdialog
125125
blazorbootstrap
126126
llms
127127
ebook
128+
cref

src/BootstrapBlazor.Server/Services/ComponentAttributeCacheService.cs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,8 @@ private static List<AttributeItem> GetAttributeCore(Type type)
7676
return null;
7777
}
7878

79-
var inheritDoc = summaryElement.Element("inheritdoc");
80-
var cref = inheritDoc?.Attribute("cref")?.Value;
81-
return cref != null ? FindSummaryElement(xmlDoc, cref) : summaryElement;
79+
var doc = summaryElement.Element("inheritdoc")?.Attribute("cref")?.Value;
80+
return doc != null ? FindSummaryElement(xmlDoc, doc) : summaryElement;
8281
}
8382

8483
private static string? GetLocalizedSummary(XElement? summaryElement)

src/BootstrapBlazor/Attributes/FileValidationAttribute.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ public class FileValidationAttribute : ValidationAttribute
3535
/// </summary>
3636
/// <param name="value"></param>
3737
/// <param name="validationContext"></param>
38-
/// <returns></returns>
3938
protected override ValidationResult? IsValid(object? value, ValidationContext validationContext)
4039
{
4140
ValidationResult? ret = null;

src/BootstrapBlazor/Components/Affix/Affix.razor.cs

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,31 +16,27 @@ public partial class Affix
1616
/// <summary>
1717
/// <para lang="zh">获得/设置 指定偏移量后触发</para>
1818
/// <para lang="en">Gets or sets the offset value to trigger</para>
19-
/// <para><version>10.2.2</version></para>
2019
/// </summary>
2120
[Parameter]
2221
public float Offset { get; set; }
2322

2423
/// <summary>
2524
/// <para lang="zh">获得/设置 固定位置枚举 默认 <see cref="AffixPosition.Top"/></para>
2625
/// <para lang="en">Gets or sets the affix position. Default is <see cref="AffixPosition.Top"/></para>
27-
/// <para><version>10.2.2</version></para>
2826
/// </summary>
2927
[Parameter]
3028
public AffixPosition Position { get; set; }
3129

3230
/// <summary>
3331
/// <para lang="zh">获得/设置 z-index 值 默认 100</para>
3432
/// <para lang="en">Gets or sets the z-index value. Default is 100</para>
35-
/// <para><version>10.2.2</version></para>
3633
/// </summary>
3734
[Parameter]
3835
public int? ZIndex { get; set; }
3936

4037
/// <summary>
4138
/// <para lang="zh">获得/设置 组件内容</para>
4239
/// <para lang="en">Gets or sets the child content</para>
43-
/// <para><version>10.2.2</version></para>
4440
/// </summary>
4541
[Parameter]
4642
[EditorRequired]

src/BootstrapBlazor/Components/Alert/Alert.razor.cs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ public partial class Alert
1515
/// <para lang="zh">获得 样式集合</para>
1616
/// <para lang="en">Gets the class name</para>
1717
/// </summary>
18-
/// <returns></returns>
1918
private string? ClassName => CssBuilder.Default("alert fade show")
2019
.AddClass($"alert-{Color.ToDescriptionString()}", Color != Color.None)
2120
.AddClass($"border-{Color.ToDescriptionString()}", ShowBorder)
@@ -31,15 +30,13 @@ public partial class Alert
3130
/// <summary>
3231
/// <para lang="zh">获得/设置 是否显示阴影 默认 false 不显示</para>
3332
/// <para lang="en">Gets or sets whether to show shadow. Default is false</para>
34-
/// <para><version>10.2.2</version></para>
3533
/// </summary>
3634
[Parameter]
3735
public bool ShowShadow { get; set; }
3836

3937
/// <summary>
4038
/// <para lang="zh">获得/设置 是否显示边框 默认 false 不显示</para>
4139
/// <para lang="en">Gets or sets whether to show border. Default is false</para>
42-
/// <para><version>10.2.2</version></para>
4340
/// </summary>
4441
[Parameter]
4542
public bool ShowBorder { get; set; }

src/BootstrapBlazor/Components/Alert/AlertBase.cs

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,47 +22,41 @@ public abstract class AlertBase : BootstrapComponentBase
2222
/// <summary>
2323
/// <para lang="zh">获得/设置 颜色</para>
2424
/// <para lang="en">Gets or sets the color</para>
25-
/// <para><version>10.2.2</version></para>
2625
/// </summary>
2726
[Parameter]
2827
public Color Color { get; set; } = Color.Primary;
2928

3029
/// <summary>
3130
/// <para lang="zh">获得/设置 是否显示关闭按钮</para>
3231
/// <para lang="en">Gets or sets whether to show the dismiss button</para>
33-
/// <para><version>10.2.2</version></para>
3432
/// </summary>
3533
[Parameter]
3634
public bool ShowDismiss { get; set; }
3735

3836
/// <summary>
3937
/// <para lang="zh">获得/设置 显示图标</para>
4038
/// <para lang="en">Gets or sets the icon</para>
41-
/// <para><version>10.2.2</version></para>
4239
/// </summary>
4340
[Parameter]
4441
public string? Icon { get; set; }
4542

4643
/// <summary>
4744
/// <para lang="zh">获得/设置 是否显示左侧 Bar</para>
4845
/// <para lang="en">Gets or sets whether to show the left bar</para>
49-
/// <para><version>10.2.2</version></para>
5046
/// </summary>
5147
[Parameter]
5248
public bool ShowBar { get; set; }
5349

5450
/// <summary>
5551
/// <para lang="zh">子组件</para>
5652
/// <para lang="en">Child content</para>
57-
/// <para><version>10.2.2</version></para>
5853
/// </summary>
5954
[Parameter]
6055
public RenderFragment? ChildContent { get; set; }
6156

6257
/// <summary>
6358
/// <para lang="zh">关闭警告框回调方法</para>
6459
/// <para lang="en">Callback method when the alert is dismissed</para>
65-
/// <para><version>10.2.2</version></para>
6660
/// </summary>
6761
[Parameter]
6862
public Func<Task>? OnDismiss { get; set; }

src/BootstrapBlazor/Components/Anchor/Anchor.razor.cs

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,20 @@ public partial class Anchor
1414
/// <summary>
1515
/// <para lang="zh">获得/设置 目标组件 Id</para>
1616
/// <para lang="en">Gets or sets the target component Id</para>
17-
/// <para><version>10.2.2</version></para>
1817
/// </summary>
1918
[Parameter]
2019
public string? Target { get; set; }
2120

2221
/// <summary>
2322
/// <para lang="zh">获得/设置 滚动组件 Id 默认为 null 使用最近滚动条容器元素</para>
2423
/// <para lang="en">Gets or sets the scroll component Id. Default is null, using the nearest scroll container element</para>
25-
/// <para><version>10.2.2</version></para>
2624
/// </summary>
2725
[Parameter]
2826
public string? Container { get; set; }
2927

3028
/// <summary>
3129
/// <para lang="zh">获得/设置 滚动时是否开启动画 默认 true</para>
3230
/// <para lang="en">Gets or sets whether to enable animation when scrolling. Default is true</para>
33-
/// <para><version>10.2.2</version></para>
3431
/// </summary>
3532
[Parameter]
3633
public bool IsAnimation { get; set; } = true;
@@ -44,15 +41,13 @@ public partial class Anchor
4441
/// <summary>
4542
/// <para lang="zh">获得/设置 距离顶端偏移量 默认为 0</para>
4643
/// <para lang="en">Gets or sets the offset from the top. Default is 0</para>
47-
/// <para><version>10.2.2</version></para>
4844
/// </summary>
4945
[Parameter]
5046
public int Offset { get; set; }
5147

5248
/// <summary>
5349
/// <para lang="zh">获得/设置 子内容</para>
5450
/// <para lang="en">Gets or sets the child content</para>
55-
/// <para><version>10.2.2</version></para>
5651
/// </summary>
5752
[Parameter]
5853
public RenderFragment? ChildContent { get; set; }

src/BootstrapBlazor/Components/AnchorLink/AnchorLink.razor.cs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,20 @@ public partial class AnchorLink
1414
/// <summary>
1515
/// <para lang="zh">获得/设置 组件 Text 显示文字</para>
1616
/// <para lang="en">Gets or sets the component text display</para>
17-
/// <para><version>10.2.2</version></para>
1817
/// </summary>
1918
[Parameter]
2019
public string? Text { get; set; }
2120

2221
/// <summary>
2322
/// <para lang="zh">获得/设置 组件 拷贝成功后 显示文字</para>
2423
/// <para lang="en">Gets or sets the display text after successful copy</para>
25-
/// <para><version>10.2.2</version></para>
2624
/// </summary>
2725
[Parameter]
2826
public string? TooltipText { get; set; }
2927

3028
/// <summary>
3129
/// <para lang="zh">获得/设置 锚点图标 默认 fa-solid fa-link</para>
3230
/// <para lang="en">Gets or sets the anchor icon. Default is fa-solid fa-link</para>
33-
/// <para><version>10.2.2</version></para>
3431
/// </summary>
3532
[Parameter]
3633
public string? Icon { get; set; }

src/BootstrapBlazor/Components/AutoComplete/AutoComplete.razor.cs

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ public partial class AutoComplete
1616
/// <summary>
1717
/// <para lang="zh">获得/设置 通过输入字符串获得的匹配数据集合</para>
1818
/// <para lang="en">Gets or sets the collection of matching data obtained by inputting a string</para>
19-
/// <para><version>10.2.2</version></para>
2019
/// </summary>
2120
[Parameter]
2221
[NotNull]
@@ -25,31 +24,27 @@ public partial class AutoComplete
2524
/// <summary>
2625
/// <para lang="zh">获得/设置 自定义集合过滤规则 默认为 null</para>
2726
/// <para lang="en">Gets or sets custom collection filtering rules, default is null</para>
28-
/// <para><version>10.2.2</version></para>
2927
/// </summary>
3028
[Parameter]
3129
public Func<string, Task<IEnumerable<string>>>? OnCustomFilter { get; set; }
3230

3331
/// <summary>
3432
/// <para lang="zh">获得/设置 图标</para>
3533
/// <para lang="en">Gets or sets the icon</para>
36-
/// <para><version>10.2.2</version></para>
3734
/// </summary>
3835
[Parameter]
3936
public string? Icon { get; set; }
4037

4138
/// <summary>
4239
/// <para lang="zh">获得/设置 加载图标</para>
4340
/// <para lang="en">Gets or sets the loading icon</para>
44-
/// <para><version>10.2.2</version></para>
4541
/// </summary>
4642
[Parameter]
4743
public string? LoadingIcon { get; set; }
4844

4945
/// <summary>
5046
/// <para lang="zh">获得/设置 匹配数据时显示的数量</para>
5147
/// <para lang="en">Gets or sets the number of items to display when matching data</para>
52-
/// <para><version>10.2.2</version></para>
5348
/// </summary>
5449
[Parameter]
5550
[NotNull]
@@ -58,31 +53,27 @@ public partial class AutoComplete
5853
/// <summary>
5954
/// <para lang="zh">获得/设置 是否开启模糊搜索 默认为 false</para>
6055
/// <para lang="en">Gets or sets whether to enable fuzzy search, default is false</para>
61-
/// <para><version>10.2.2</version></para>
6256
/// </summary>
6357
[Parameter]
6458
public bool IsLikeMatch { get; set; }
6559

6660
/// <summary>
6761
/// <para lang="zh">获得/设置 匹配时是否忽略大小写 默认为 true</para>
6862
/// <para lang="en">Gets or sets whether to ignore case when matching, default is true</para>
69-
/// <para><version>10.2.2</version></para>
7063
/// </summary>
7164
[Parameter]
7265
public bool IgnoreCase { get; set; } = true;
7366

7467
/// <summary>
7568
/// <para lang="zh">获得/设置 获得焦点时是否展开下拉候选菜单 默认为 true</para>
7669
/// <para lang="en">Gets or sets whether to expand the dropdown candidate menu when focused, default is true</para>
77-
/// <para><version>10.2.2</version></para>
7870
/// </summary>
7971
[Parameter]
8072
public bool ShowDropdownListOnFocus { get; set; } = true;
8173

8274
/// <summary>
8375
/// <para lang="zh">获得/设置 是否显示无匹配数据选项 默认为 true</para>
8476
/// <para lang="en">Gets or sets whether to show the no matching data option, default is true</para>
85-
/// <para><version>10.2.2</version></para>
8677
/// </summary>
8778
[Parameter]
8879
public bool ShowNoDataTip { get; set; } = true;
@@ -162,7 +153,6 @@ protected override void OnParametersSet()
162153
/// <inheritdoc/>
163154
/// </summary>
164155
/// <param name="firstRender"></param>
165-
/// <returns></returns>
166156
protected override async Task OnAfterRenderAsync(bool firstRender)
167157
{
168158
await base.OnAfterRenderAsync(firstRender);
@@ -180,7 +170,6 @@ protected override async Task OnAfterRenderAsync(bool firstRender)
180170
/// <summary>
181171
/// <inheritdoc/>
182172
/// </summary>
183-
/// <returns></returns>
184173
protected override Task InvokeInitAsync() => InvokeVoidAsync("init", Id, Interop, Value, GetChangedEventCallbackName());
185174

186175
private string? GetChangedEventCallbackName() => (OnValueChanged != null || ValueChanged.HasDelegate) ? nameof(TriggerChange) : null;
@@ -189,7 +178,6 @@ protected override async Task OnAfterRenderAsync(bool firstRender)
189178
/// <para lang="zh">获得 是否显示清除按钮</para>
190179
/// <para lang="en">Gets whether show the clear button.</para>
191180
/// </summary>
192-
/// <returns></returns>
193181
private bool GetClearable() => IsClearable && !IsDisabled;
194182

195183
/// <summary>
@@ -222,7 +210,6 @@ private async Task OnClickItem(string val)
222210
/// <para lang="zh">点击清空按钮时调用此方法 由 Javascript 触发</para>
223211
/// <para lang="en">Method called when the clear button is clicked. Triggered by Javascript</para>
224212
/// </summary>
225-
/// <returns></returns>
226213
[JSInvokable]
227214
public async Task TriggerClear()
228215
{
@@ -268,7 +255,6 @@ public async Task TriggerFilter(string val)
268255
/// <para lang="en">Supports two-way binding. Triggered by client-side JavaScript</para>
269256
/// </summary>
270257
/// <param name="v"></param>
271-
/// <returns></returns>
272258
[JSInvokable]
273259
public void TriggerChange(string v)
274260
{

0 commit comments

Comments
 (0)