doc(Components): update comments for component

exclusion.dic

@@ -125,3 +125,4 @@ alertdialog
 blazorbootstrap
 llms
 ebook
+cref

src/BootstrapBlazor.Server/Services/ComponentAttributeCacheService.cs

@@ -76,9 +76,8 @@ private static List<AttributeItem> GetAttributeCore(Type type)
             return null;
         }
 
-        var inheritDoc = summaryElement.Element("inheritdoc");
-        var cref = inheritDoc?.Attribute("cref")?.Value;
-        return cref != null ? FindSummaryElement(xmlDoc, cref) : summaryElement;
+        var doc = summaryElement.Element("inheritdoc")?.Attribute("cref")?.Value;
+        return doc != null ? FindSummaryElement(xmlDoc, doc) : summaryElement;
     }
 
     private static string? GetLocalizedSummary(XElement? summaryElement)

src/BootstrapBlazor/Attributes/FileValidationAttribute.cs

@@ -35,7 +35,6 @@ public class FileValidationAttribute : ValidationAttribute
     /// </summary>
     /// <param name="value"></param>
     /// <param name="validationContext"></param>
-    /// <returns></returns>
     protected override ValidationResult? IsValid(object? value, ValidationContext validationContext)
     {
         ValidationResult? ret = null;

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

@@ -16,31 +16,27 @@ public partial class Affix
     /// <summary>
     /// <para lang="zh">获得/设置 指定偏移量后触发</para>
     /// <para lang="en">Gets or sets the offset value to trigger</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public float Offset { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 固定位置枚举 默认 <see cref="AffixPosition.Top"/></para>
     /// <para lang="en">Gets or sets the affix position. Default is <see cref="AffixPosition.Top"/></para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public AffixPosition Position { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 z-index 值 默认 100</para>
     /// <para lang="en">Gets or sets the z-index value. Default is 100</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public int? ZIndex { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 组件内容</para>
     /// <para lang="en">Gets or sets the child content</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     [EditorRequired]

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

@@ -15,7 +15,6 @@ public partial class Alert
     /// <para lang="zh">获得 样式集合</para>
     /// <para lang="en">Gets the class name</para>
     /// </summary>
-    /// <returns></returns>
     private string? ClassName => CssBuilder.Default("alert fade show")
         .AddClass($"alert-{Color.ToDescriptionString()}", Color != Color.None)
         .AddClass($"border-{Color.ToDescriptionString()}", ShowBorder)
@@ -31,15 +30,13 @@ public partial class Alert
     /// <summary>
     /// <para lang="zh">获得/设置 是否显示阴影 默认 false 不显示</para>
     /// <para lang="en">Gets or sets whether to show shadow. Default is false</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public bool ShowShadow { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 是否显示边框 默认 false 不显示</para>
     /// <para lang="en">Gets or sets whether to show border. Default is false</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public bool ShowBorder { get; set; }

src/BootstrapBlazor/Components/Alert/AlertBase.cs

@@ -22,47 +22,41 @@ public abstract class AlertBase : BootstrapComponentBase
     /// <summary>
     /// <para lang="zh">获得/设置 颜色</para>
     /// <para lang="en">Gets or sets the color</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public Color Color { get; set; } = Color.Primary;
 
     /// <summary>
     /// <para lang="zh">获得/设置 是否显示关闭按钮</para>
     /// <para lang="en">Gets or sets whether to show the dismiss button</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public bool ShowDismiss { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 显示图标</para>
     /// <para lang="en">Gets or sets the icon</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public string? Icon { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 是否显示左侧 Bar</para>
     /// <para lang="en">Gets or sets whether to show the left bar</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public bool ShowBar { get; set; }
 
     /// <summary>
     /// <para lang="zh">子组件</para>
     /// <para lang="en">Child content</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public RenderFragment? ChildContent { get; set; }
 
     /// <summary>
     /// <para lang="zh">关闭警告框回调方法</para>
     /// <para lang="en">Callback method when the alert is dismissed</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public Func<Task>? OnDismiss { get; set; }

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

@@ -14,23 +14,20 @@ public partial class Anchor
     /// <summary>
     /// <para lang="zh">获得/设置 目标组件 Id</para>
     /// <para lang="en">Gets or sets the target component Id</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public string? Target { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 滚动组件 Id 默认为 null 使用最近滚动条容器元素</para>
     /// <para lang="en">Gets or sets the scroll component Id. Default is null, using the nearest scroll container element</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public string? Container { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 滚动时是否开启动画 默认 true</para>
     /// <para lang="en">Gets or sets whether to enable animation when scrolling. Default is true</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public bool IsAnimation { get; set; } = true;
@@ -44,15 +41,13 @@ public partial class Anchor
     /// <summary>
     /// <para lang="zh">获得/设置 距离顶端偏移量 默认为 0</para>
     /// <para lang="en">Gets or sets the offset from the top. Default is 0</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public int Offset { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 子内容</para>
     /// <para lang="en">Gets or sets the child content</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public RenderFragment? ChildContent { get; set; }

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

@@ -14,23 +14,20 @@ public partial class AnchorLink
     /// <summary>
     /// <para lang="zh">获得/设置 组件 Text 显示文字</para>
     /// <para lang="en">Gets or sets the component text display</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public string? Text { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 组件 拷贝成功后 显示文字</para>
     /// <para lang="en">Gets or sets the display text after successful copy</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public string? TooltipText { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 锚点图标 默认 fa-solid fa-link</para>
     /// <para lang="en">Gets or sets the anchor icon. Default is fa-solid fa-link</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public string? Icon { get; set; }

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

@@ -16,7 +16,6 @@ public partial class AutoComplete
     /// <summary>
     /// <para lang="zh">获得/设置 通过输入字符串获得的匹配数据集合</para>
     /// <para lang="en">Gets or sets the collection of matching data obtained by inputting a string</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     [NotNull]
@@ -25,31 +24,27 @@ public partial class AutoComplete
     /// <summary>
     /// <para lang="zh">获得/设置 自定义集合过滤规则 默认为 null</para>
     /// <para lang="en">Gets or sets custom collection filtering rules, default is null</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public Func<string, Task<IEnumerable<string>>>? OnCustomFilter { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 图标</para>
     /// <para lang="en">Gets or sets the icon</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public string? Icon { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 加载图标</para>
     /// <para lang="en">Gets or sets the loading icon</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public string? LoadingIcon { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 匹配数据时显示的数量</para>
     /// <para lang="en">Gets or sets the number of items to display when matching data</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     [NotNull]
@@ -58,31 +53,27 @@ public partial class AutoComplete
     /// <summary>
     /// <para lang="zh">获得/设置 是否开启模糊搜索 默认为 false</para>
     /// <para lang="en">Gets or sets whether to enable fuzzy search, default is false</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public bool IsLikeMatch { get; set; }
 
     /// <summary>
     /// <para lang="zh">获得/设置 匹配时是否忽略大小写 默认为 true</para>
     /// <para lang="en">Gets or sets whether to ignore case when matching, default is true</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public bool IgnoreCase { get; set; } = true;
 
     /// <summary>
     /// <para lang="zh">获得/设置 获得焦点时是否展开下拉候选菜单 默认为 true</para>
     /// <para lang="en">Gets or sets whether to expand the dropdown candidate menu when focused, default is true</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public bool ShowDropdownListOnFocus { get; set; } = true;
 
     /// <summary>
     /// <para lang="zh">获得/设置 是否显示无匹配数据选项 默认为 true</para>
     /// <para lang="en">Gets or sets whether to show the no matching data option, default is true</para>
-    /// <para><version>10.2.2</version></para>
     /// </summary>
     [Parameter]
     public bool ShowNoDataTip { get; set; } = true;
@@ -162,7 +153,6 @@ protected override void OnParametersSet()
     /// <inheritdoc/>
     /// </summary>
     /// <param name="firstRender"></param>
-    /// <returns></returns>
     protected override async Task OnAfterRenderAsync(bool firstRender)
     {
         await base.OnAfterRenderAsync(firstRender);
@@ -180,7 +170,6 @@ protected override async Task OnAfterRenderAsync(bool firstRender)
     /// <summary>
     /// <inheritdoc/>
     /// </summary>
-    /// <returns></returns>
     protected override Task InvokeInitAsync() => InvokeVoidAsync("init", Id, Interop, Value, GetChangedEventCallbackName());
 
     private string? GetChangedEventCallbackName() => (OnValueChanged != null || ValueChanged.HasDelegate) ? nameof(TriggerChange) : null;
@@ -189,7 +178,6 @@ protected override async Task OnAfterRenderAsync(bool firstRender)
     /// <para lang="zh">获得 是否显示清除按钮</para>
     /// <para lang="en">Gets whether show the clear button.</para>
     /// </summary>
-    /// <returns></returns>
     private bool GetClearable() => IsClearable && !IsDisabled;
 
     /// <summary>
@@ -222,7 +210,6 @@ private async Task OnClickItem(string val)
     /// <para lang="zh">点击清空按钮时调用此方法 由 Javascript 触发</para>
     /// <para lang="en">Method called when the clear button is clicked. Triggered by Javascript</para>
     /// </summary>
-    /// <returns></returns>
     [JSInvokable]
     public async Task TriggerClear()
     {
@@ -268,7 +255,6 @@ public async Task TriggerFilter(string val)
     /// <para lang="en">Supports two-way binding. Triggered by client-side JavaScript</para>
     /// </summary>
     /// <param name="v"></param>
-    /// <returns></returns>
     [JSInvokable]
     public void TriggerChange(string v)
     {