doc: 更新参数注释值

Author: ArgoZhang

src/components/BootstrapBlazor.DockView/Components/DockViewComponent.cs

@@ -9,126 +9,146 @@
 namespace BootstrapBlazor.Components;
 
 /// <summary>
-/// DockContentItem 配置项子项对标 content 配置项内部 content 配置
+/// <para lang="zh">DockContentItem 配置项子项对标 content 配置项内部 content 配置</para>
+/// <para lang="en">DockContentItem configuration item sub-item corresponds to the content configuration item inside the content configuration item</para>
 /// </summary>
 public class DockViewComponent : DockViewComponentBase
 {
     /// <summary>
-    /// 获得/设置 组件是否显示 Header 默认 true 显示
+    /// <para lang="zh">获得/设置 组件是否显示 Header 默认 true 显示</para>
+    /// <para lang="en">Gets or sets whether the component header is displayed. Default is true.</para>
     /// </summary>
     [Parameter]
     public bool ShowHeader { get; set; } = true;
 
     /// <summary>
-    /// 获得/设置 组件 Title
+    /// <para lang="zh">获得/设置 组件 Title</para>
+    /// <para lang="en">Gets or sets the component title.</para>
     /// </summary>
     [Parameter]
     public string? Title { get; set; }
 
     /// <summary>
-    /// 获得/设置 组件 Title 宽度 默认 null 未设置
+    /// <para lang="zh">获得/设置 组件 Title 宽度 默认 null 未设置</para>
+    /// <para lang="en">Gets or sets the component title width. Default is null (not set).</para>
     /// </summary>
     [Parameter]
     public int? TitleWidth { get; set; }
 
     /// <summary>
-    /// 获得/设置 组件 Title 样式 默认 null 未设置
+    /// <para lang="zh">获得/设置 组件 Title 样式 默认 null 未设置</para>
+    /// <para lang="en">Gets or sets the component title style. Default is null (not set).</para>
     /// </summary>
     [Parameter]
     public string? TitleClass { get; set; }
 
     /// <summary>
-    /// 获得/设置 Title 模板 默认 null 未设置
+    /// <para lang="zh">获得/设置 Title 模板 默认 null 未设置</para>
+    /// <para lang="en">Gets or sets the title template. Default is null (not set).</para>
     /// </summary>
     [Parameter]
     [JsonIgnore]
     public RenderFragment? TitleTemplate { get; set; }
 
     /// <summary>
-    /// 获得/设置 组件 Class 默认 null 未设置
+    /// <para lang="zh">获得/设置 组件 Class 默认 null 未设置</para>
+    /// <para lang="en">Gets or sets the component class. Default is null (not set).</para>
     /// </summary>
     [Parameter]
     public string? Class { get; set; }
 
     /// <summary>
-    /// 获得/设置 组件是否可见 默认 true 可见
+    /// <para lang="zh">获得/设置 组件是否可见 默认 true 可见</para>
+    /// <para lang="en">Gets or sets whether the component is visible. Default is true.</para>
     /// </summary>
     [Parameter]
     public bool Visible { get; set; } = true;
 
     /// <summary>
-    /// 获得/设置 组件是否允许关闭 默认 null 使用 DockView 的配置
+    /// <para lang="zh">获得/设置 组件是否允许关闭 默认 null 使用 DockView 的配置</para>
+    /// <para lang="en">Gets or sets whether the component is allowed to be closed. Default is null (uses DockView configuration).</para>
     /// </summary>
     [Parameter]
     public bool? ShowClose { get; set; }
 
     /// <summary>
-    /// 获得/设置 组件唯一标识值 默认 null 未设置时取 Title 作为唯一标识
+    /// <para lang="zh">获得/设置 组件唯一标识值 默认 null 未设置时取 Title 作为唯一标识</para>
+    /// <para lang="en">Gets or sets the unique identifier for the component. Default is null, uses Title as the identifier if not set.</para>
     /// </summary>
     [Parameter]
     public string? Key { get; set; }
 
     /// <summary>
-    /// 获得/设置 是否锁定 默认 null 未设置时取 DockView 的配置
+    /// <para lang="zh">获得/设置 是否锁定 默认 null 未设置时取 DockView 的配置</para>
+    /// <para lang="en">Gets or sets whether the component is locked. Default is null (uses DockView configuration).</para>
     /// </summary>
     /// <remarks>锁定后无法拖动</remarks>
     [Parameter]
     public bool? IsLock { get; set; }
 
     /// <summary>
-    /// 获得/设置 是否显示锁定按钮 默认 null 未设置时取 DockView 的配置
+    /// <para lang="zh">获得/设置 是否显示锁定按钮 默认 null 未设置时取 DockView 的配置</para>
+    /// <para lang="en">Gets or sets whether the lock button is displayed. Default is null (uses DockView configuration).</para>
     /// </summary>
     [Parameter]
     public bool? ShowLock { get; set; }
 
     /// <summary>
-    /// 获得/设置 是否悬浮 默认 null 未设置时取 DockView 的配置
+    /// <para lang="zh">获得/设置 是否悬浮 默认 null 未设置时取 DockView 的配置</para>
+    /// <para lang="en">Gets or sets whether the component is floating. Default is null (uses DockView configuration).</para>
     /// </summary>
     [Parameter]
     public bool? IsFloating { get; set; }
 
     /// <summary>
-    /// 获得/设置 是否显示可悬浮按钮 默认 null 未设置时取 DockView 的配置
+    /// <para lang="zh">获得/设置 是否显示可悬浮按钮 默认 null 未设置时取 DockView 的配置</para>
+    /// <para lang="en">Gets or sets whether the float button is displayed. Default is null (uses DockView configuration).</para>
     /// </summary>
     [Parameter]
     public bool? ShowFloat { get; set; }
 
     /// <summary>
-    /// 获得/设置 是否显示最大化按钮 默认 null 未设置时取 DockView 的配置
+    /// <para lang="zh">获得/设置 是否显示最大化按钮 默认 null 未设置时取 DockView 的配置</para>
+    /// <para lang="en">Gets or sets whether the maximize button is displayed. Default is null (uses DockView configuration).</para>
     /// </summary>
     [Parameter]
     public bool? ShowMaximize { get; set; }
 
     /// <summary>
-    /// 获得/设置 是否一直显示 默认 null 未设置时取 DockView 的配置
+    /// <para lang="zh">获得/设置 是否一直显示 默认 null 未设置时取 DockView 的配置</para>
+    /// <para lang="en">Gets or sets whether the component is always displayed. Default is null (uses DockView configuration).</para>
     /// </summary>
     [Parameter]
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
     public string? Renderer { get; set; }
 
     /// <summary>
-    /// 获得/设置 是否显示标题前置图标 默认 false 不显示
+    /// <para lang="zh">获得/设置 是否显示标题前置图标 默认 false 不显示</para>
+    /// <para lang="en">Gets or sets whether the title bar icon is displayed. Default is false.</para>
     /// </summary>
     [Parameter]
     [JsonIgnore]
     public bool ShowTitleBar { get; set; }
 
     /// <summary>
-    /// 获得/设置 标题前置图标 默认 null 未设置使用默认图标
+    /// <para lang="zh">获得/设置 标题前置图标 默认 null 未设置使用默认图标</para>
+    /// <para lang="en">Gets or sets the title bar icon. Default is null, uses the default icon if not set.</para>
     /// </summary>
     [Parameter]
     [JsonIgnore]
     public string? TitleBarIcon { get; set; }
 
     /// <summary>
-    /// 获得/设置 标题前置图标 Url 默认 null 未设置使用默认图标
+    /// <para lang="zh">获得/设置 标题前置图标 Url 默认 null 未设置使用默认图标</para>
+    /// <para lang="en">Gets or sets the title bar icon URL. Default is null, uses the default icon if not set.</para>
     /// </summary>
     [Parameter]
     [JsonIgnore]
     public string? TitleBarIconUrl { get; set; }
 
     /// <summary>
-    /// 获得/设置 标题前置图标点击回调方法 默认 null
+    /// <para lang="zh">获得/设置 标题前置图标点击回调方法 默认 null</para>
+    /// <para lang="en">Gets or sets the callback method for clicking the title bar icon. Default is null.</para>
     /// </summary>
     [Parameter]
     [JsonIgnore]
@@ -192,7 +212,8 @@ private async Task OnClickBar()
     }
 
     /// <summary>
-    /// 设置 Visible 参数方法
+    /// <para lang="zh">设置 Visible 参数方法</para>
+    /// <para lang="en">Sets the Visible parameter.</para>
     /// </summary>
     /// <param name="visible"></param>
     public void SetVisible(bool visible)

src/components/BootstrapBlazor.DockView/Components/DockViewComponentBase.cs

@@ -1,4 +1,4 @@
-// Copyright (c) Argo Zhang (argo@163.com). All rights reserved.
+// Copyright (c) Argo Zhang (argo@163.com). All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 // Website: https://www.blazor.zone or https://argozhang.github.io/
 
@@ -8,37 +8,43 @@
 namespace BootstrapBlazor.Components;
 
 /// <summary>
-/// DockComponent 基类
+/// <para lang="zh">DockComponent 基类</para>
+/// <para lang="en">Base class for DockComponent</para>
 /// </summary>
 public abstract class DockViewComponentBase : IdComponentBase, IDisposable
 {
     /// <summary>
-    /// 获得/设置 渲染类型 默认 Component
+    /// <para lang="zh">获得/设置 渲染类型 默认 Component</para>
+    /// <para lang="en">Gets or sets the render type. Default is Component.</para>
     /// </summary>
     [Parameter]
     public DockViewContentType Type { get; set; }
 
     /// <summary>
-    /// 获得/设置 组件宽度百分比 默认 null 未设置
+    /// <para lang="zh">获得/设置 组件宽度百分比 默认 null 未设置</para>
+    /// <para lang="en">Gets or sets the component width percentage. Default is null (not set).</para>
     /// </summary>
     [Parameter]
     public int? Width { get; set; }
 
     /// <summary>
-    /// 获得/设置 组件高度百分比 默认 null 未设置
+    /// <para lang="zh">获得/设置 组件高度百分比 默认 null 未设置</para>
+    /// <para lang="en">Gets or sets the component height percentage. Default is null (not set).</para>
     /// </summary>
     [Parameter]
     public int? Height { get; set; }
 
     /// <summary>
-    /// 获得/设置 子组件
+    /// <para lang="zh">获得/设置 子组件</para>
+    /// <para lang="en">Gets or sets the child content.</para>
     /// </summary>
     [Parameter]
     [JsonIgnore]
     public RenderFragment? ChildContent { get; set; }
 
     /// <summary>
-    /// 获得/设置 DockContent 实例
+    /// <para lang="zh">获得/设置 DockContent 实例</para>
+    /// <para lang="en">Gets or sets the DockContent instance.</para>
     /// </summary>
     [CascadingParameter]
     private List<DockViewComponentBase>? Parent { get; set; }
@@ -54,7 +60,8 @@ protected override void OnInitialized()
     }
 
     /// <summary>
-    /// 资源销毁方法
+    /// <para lang="zh">资源销毁方法</para>
+    /// <para lang="en">Resource disposal method</para>
     /// </summary>
     /// <param name="disposing"></param>
     protected virtual void Dispose(bool disposing)
@@ -66,7 +73,8 @@ protected virtual void Dispose(bool disposing)
     }
 
     /// <summary>
-    /// 资源销毁方法
+    /// <para lang="zh">资源销毁方法</para>
+    /// <para lang="en">Resource disposal method</para>
     /// </summary>
     public void Dispose()
     {

src/components/BootstrapBlazor.DockView/Components/DockViewConfig.cs

@@ -9,98 +9,116 @@ namespace BootstrapBlazor.Components;
 class DockViewConfig
 {
     /// <summary>
-    /// 获得/设置 是否启用本地布局保持 默认 true
+    /// <para lang="zh">获得/设置 是否启用本地布局保持 默认 true</para>
+    /// <para lang="en">Gets or sets whether to enable local layout persistence. Default is true.</para>
     /// </summary>
     public bool EnableLocalStorage { get; set; } = true;
 
     /// <summary>
-    /// 获得/设置 是否锁定 默认 false
+    /// <para lang="zh">获得/设置 是否锁定 默认 false</para>
+    /// <para lang="en">Gets or sets whether the component is locked. Default is false.</para>
     /// </summary>
     /// <remarks>锁定后无法拖动</remarks>
     [JsonPropertyName("lock")]
     public bool IsLock { get; set; }
 
     /// <summary>
-    /// 获得/设置 是否显示锁定按钮 默认 true 显示
+    /// <para lang="zh">获得/设置 是否显示锁定按钮 默认 true 显示</para>
+    /// <para lang="en">Gets or sets whether the lock button is displayed. Default is true.</para>
     /// </summary>
     public bool ShowLock { get; set; }
 
     /// <summary>
-    /// 获得/设置 是否悬浮 默认 false
+    /// <para lang="zh">获得/设置 是否悬浮 默认 false</para>
+    /// <para lang="en">Gets or sets whether the component is floating. Default is false.</para>
     /// </summary>
     /// <remarks>锁定后无法拖动</remarks>
     public bool IsFloating { get; set; }
 
     /// <summary>
-    /// 获得/设置 是否显示可悬浮按钮 默认 true
+    /// <para lang="zh">获得/设置 是否显示可悬浮按钮 默认 true</para>
+    /// <para lang="en">Gets or sets whether the float button is displayed. Default is true.</para>
     /// </summary>
     public bool ShowFloat { get; set; } = true;
 
     /// <summary>
-    /// 获得/设置 是否显示关闭按钮 默认 true 显示
+    /// <para lang="zh">获得/设置 是否显示关闭按钮 默认 true 显示</para>
+    /// <para lang="en">Gets or sets whether the close button is displayed. Default is true.</para>
     /// </summary>
     public bool ShowClose { get; set; }
 
     /// <summary>
-    /// 获得/设置 是否显示显示图钉按钮 默认 true
+    /// <para lang="zh">获得/设置 是否显示图钉按钮 默认 true</para>
+    /// <para lang="en">Gets or sets whether the pin button is displayed. Default is true.</para>
     /// </summary>
     public bool ShowPin { get; set; } = true;
 
     /// <summary>
-    /// 获得/设置 是否显示最大化按钮 默认 true
+    /// <para lang="zh">获得/设置 是否显示最大化按钮 默认 true</para>
+    /// <para lang="en">Gets or sets whether the maximize button is displayed. Default is true.</para>
     /// </summary>
     public bool ShowMaximize { get; set; } = true;
 
     /// <summary>
-    /// 获得/设置 客户端渲染模式 默认 null 客户端默认使用 always onlyWhenVisible 值
+    /// <para lang="zh">获得/设置 客户端渲染模式 默认 null 客户端默认使用 always onlyWhenVisible 值</para>
+    /// <para lang="en">Gets or sets the client render mode. Default is null, the client will use always onlyWhenVisible value.</para>
     /// </summary>
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
     public DockViewRenderMode Renderer { get; set; }
 
     /// <summary>
-    /// 获得/设置 标签页可见状态改变事件回调
+    /// <para lang="zh">获得/设置 标签页可见状态改变事件回调</para>
+    /// <para lang="en">Gets or sets the callback for when the tab visibility changes.</para>
     /// </summary>
     public string? PanelVisibleChangedCallback { get; set; }
 
     /// <summary>
-    /// 获得/设置 组件初始化完成事件回调
+    /// <para lang="zh">获得/设置 组件初始化完成事件回调</para>
+    /// <para lang="en">Gets or sets the callback for when the component is initialized.</para>
     /// </summary>
     public string? InitializedCallback { get; set; }
 
     /// <summary>
-    /// 获得/设置 锁定事件回调
+    /// <para lang="zh">获得/设置 锁定事件回调</para>
+    /// <para lang="en">Gets or sets the callback for when the lock state changes.</para>
     /// </summary>
     public string? LockChangedCallback { get; set; }
 
     /// <summary>
-    /// 获得/设置 分割栏调整事件回调
+    /// <para lang="zh">获得/设置 分割栏调整事件回调</para>
+    /// <para lang="en">Gets or sets the callback for when the splitter is adjusted.</para>
     /// </summary>
     public string? SplitterCallback { get; set; }
 
     /// <summary>
-    /// 获得/设置 加载当前激活标签页事件回调
+    /// <para lang="zh">获得/设置 加载当前激活标签页事件回调</para>
+    /// <para lang="en">Gets or sets the callback for loading the currently active tab.</para>
     /// </summary>
     public string? LoadTabs { get; set; }
 
     /// <summary>
-    /// 获得/设置 客户端缓存键值
+    /// <para lang="zh">获得/设置 客户端缓存键值</para>
+    /// <para lang="en">Gets or sets the client-side cache key.</para>
     /// </summary>
     public string? LocalStorageKey { get; set; }
 
     /// <summary>
-    /// 获得/设置 Golden-Layout 配置项集合 默认 空集合
+    /// <para lang="zh">获得/设置 配置项集合 默认 空集合</para>
+    /// <para lang="en">Gets or sets the configuration items. Default is an empty collection.</para>
     /// </summary>
     [JsonPropertyName("content")]
     [JsonConverter(typeof(DockViewComponentConverter))]
     public List<DockViewComponentBase> Contents { get; set; } = [];
 
     /// <summary>
-    /// 获得/设置 组件主题 默认 null 未设置
+    /// <para lang="zh">获得/设置 组件主题 默认 null 未设置</para>
+    /// <para lang="en">Gets or sets the component theme. Default is null, not set.</para>
     /// </summary>
     public string? Theme { get; set; }
 
     /// <summary>
-    /// 获得/设置 布局配置 默认 null 未设置
+    /// <para lang="zh">获得/设置 布局配置 默认 null 未设置</para>
+    /// <para lang="en">Gets or sets the layout configuration. Default is null, not set.</para>
     /// </summary>
     public string? LayoutConfig { get; set; }
 }