Skip to content

Commit 87ba5bc

Browse files
ArgoZhangArgoZhang
authored
doc(Components): update xml comments (#7560)
1 parent 2e4d93f commit 87ba5bc

5 files changed

Lines changed: 44 additions & 74 deletions

File tree

‎src/BootstrapBlazor.Server/Components/Pages/Error.razor‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
@page "/error"
2-
1+
@page "/error"
32

43
<h1 class="text-danger">Error.</h1>
54
<h2 class="text-danger">An error occurred while processing your request.</h2>
@@ -13,4 +12,4 @@
1312
It can result in displaying sensitive information from exceptions to end users.
1413
For local debugging, enable the <strong>Development</strong> environment by setting the <strong>ASPNETCORE_ENVIRONMENT</strong> environment variable to <strong>Development</strong>
1514
and restarting the app.
16-
</p>
15+
</p>

‎src/BootstrapBlazor.Server/Components/Samples/TreeViews.razor.cs‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ private Task OnMaxSelectedCountExceed()
182182

183183
private Task OnTreeItemChecked(List<TreeViewItem<TreeFoo>> items)
184184
{
185-
Logger2.Log($"当前共选中{items.Count}项");
185+
Logger2.Log($"当前共选中 {items.Count} 项");
186186
return Task.CompletedTask;
187187
}
188188

@@ -201,9 +201,7 @@ private static List<TreeFoo> GetDraggableItems()
201201

202202
new() { Text = "Item C", Id = "3", Icon = "fa-solid fa-font-awesome" },
203203
new() { Text = "Item H", Id = "7", ParentId = "3", Icon = "fa-solid fa-font-awesome" },
204-
new() { Text = "Item I", Id = "8", ParentId = "3", Icon = "fa-solid fa-font-awesome" },
205-
206-
204+
new() { Text = "Item I", Id = "8", ParentId = "3", Icon = "fa-solid fa-font-awesome" }
207205
];
208206
return _dragItems;
209207
}

‎src/BootstrapBlazor/Components/Tab/TabItemContent.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ class TabItemContent : IComponent, IHandlerException, IDisposable
1212
{
1313
/// <summary>
1414
/// <para lang="zh">获得/设置 标签项，默认为 null</para>
15-
/// <para lang="en">Gets or sets the component content. Default is null.</para>
15+
/// <para lang="en">Gets or sets the component content. Default is null</para>
1616
/// </summary>
1717
[Parameter, NotNull]
1818
public TabItem? Item { get; set; }

‎src/BootstrapBlazor/Extensions/LocalizationOptionsExtensions.cs‎

Lines changed: 2 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,16 @@ namespace BootstrapBlazor.Components;
1616
internal static class LocalizationOptionsExtensions
1717
{
1818
/// <summary>
19-
/// <para lang="zh">通过系统 JsonLocalizationOptions 获取当前 Json 格式资源配置集合</para>
20-
/// <para lang="en">Get the current Json format resource configuration collection through the system JsonLocalizationOptions</para>
19+
/// <para lang="zh">通过系统 <see cref="JsonLocalizationOptions"/> 获取当前 Json 格式资源配置集合</para>
20+
/// <para lang="en">Get the current Json format resource configuration collection through the system <see cref="JsonLocalizationOptions"/></para>
2121
/// </summary>
2222
/// <param name="option"></param>
2323
/// <param name="assembly"></param>
2424
/// <param name="cultureName"></param>
2525
public static IEnumerable<IConfigurationSection> GetJsonStringFromAssembly(this JsonLocalizationOptions option, Assembly assembly, string cultureName)
2626
{
27-
// <para lang="zh">创建配置 ConfigurationBuilder</para>
28-
// <para lang="en">Create configuration ConfigurationBuilder</para>
2927
var builder = new ConfigurationBuilder();
30-
31-
// <para lang="zh">获取程序集中的资源文件</para>
32-
// <para lang="en">Get the resource file in the assembly</para>
3328
var assemblies = new List<Assembly>() { assembly };
34-
35-
// <para lang="zh">获得主程序集资源文件</para>
36-
// <para lang="en">Get the main assembly resource file</para>
37-
// <para lang="zh">支持合并操作</para>
38-
// <para lang="en">Support merge operation</para>
3929
var entryAssembly = GetEntryAssembly();
4030
if (assembly != entryAssembly)
4131
{
@@ -49,15 +39,11 @@ public static IEnumerable<IConfigurationSection> GetJsonStringFromAssembly(this
4939

5040
var streams = assemblies.SelectMany(i => option.GetResourceStream(i, cultureName)).ToList();
5141

52-
// <para lang="zh">添加 Json 文件流到配置</para>
53-
// <para lang="en">Add Json file stream to configuration</para>
5442
foreach (var s in streams)
5543
{
5644
builder.AddJsonStream(s);
5745
}
5846

59-
// <para lang="zh">获得配置外置资源文件</para>
60-
// <para lang="en">Get configuration external resource file</para>
6147
if (option.AdditionalJsonFiles != null)
6248
{
6349
var files = option.AdditionalJsonFiles.Where(f =>
@@ -71,11 +57,8 @@ public static IEnumerable<IConfigurationSection> GetJsonStringFromAssembly(this
7157
}
7258
}
7359

74-
// <para lang="zh">生成 IConfigurationRoot</para>
75-
// <para lang="en">Generate IConfigurationRoot</para>
7660
var config = builder.Build();
7761

78-
// dispose json stream
7962
foreach (var s in streams)
8063
{
8164
s.Dispose();
@@ -92,23 +75,17 @@ private static List<Stream> GetResourceStream(this JsonLocalizationOptions optio
9275
var resourceNames = assembly.GetManifestResourceNames();
9376
var ret = new List<Stream>();
9477

95-
// <para lang="zh">如果开启回落机制优先增加回落语言</para>
96-
// <para lang="en">If the fallback mechanism is enabled, priority is given to increasing the fallback language</para>
9778
if (option.EnableFallbackCulture)
9879
{
9980
AddStream(option.FallbackCulture);
10081
}
10182

102-
// <para lang="zh">查找父资源</para>
103-
// <para lang="en">Find parent resources</para>
10483
var parentName = GetParentCultureName(cultureName).Value;
10584
if (!string.IsNullOrEmpty(parentName) && !EqualFallbackCulture(parentName))
10685
{
10786
AddStream(parentName);
10887
}
10988

110-
// <para lang="zh">当前文化资源</para>
111-
// <para lang="en">Current culture resources</para>
11289
if (!EqualFallbackCulture(cultureName))
11390
{
11491
AddStream(cultureName);
@@ -129,8 +106,6 @@ void AddStream(string name)
129106
}
130107
}
131108

132-
// <para lang="zh">开启回落机制并且当前文化信息与回落语言相同</para>
133-
// <para lang="en">Open the fallback mechanism and the current cultural information is the same as the fallback language</para>
134109
bool EqualFallbackCulture(string name) => option.EnableFallbackCulture && option.FallbackCulture == name;
135110
}
136111

‎src/BootstrapBlazor/Extensions/ToastServiceExtensions.cs‎

Lines changed: 37 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -7,31 +7,29 @@ namespace BootstrapBlazor.Components;
77

88
/// <summary>
99
/// <para lang="zh">ToastService 扩展方法</para>
10-
/// <para lang="en">ToastService 扩展方法</para>
10+
/// <para lang="en">ToastService extension methods</para>
1111
/// </summary>
1212
public static class ToastServiceExtensions
1313
{
14-
// 特别备注：此处方法使用三个参数被 UniLite 插件系统使用，请勿删除
15-
1614
/// <summary>
1715
/// <para lang="zh">Toast 调用成功快捷方法</para>
18-
/// <para lang="en">Toast 调用成功快捷方法</para>
16+
/// <para lang="en">Toast success shortcut method</para>
1917
/// </summary>
2018
/// <param name="service"></param>
21-
/// <param name="title"><para lang="zh">Title 属性</para><para lang="en">Title property</para></param>
22-
/// <param name="content"><para lang="zh">Content 属性</para><para lang="en">Content property</para></param>
23-
/// <param name="autoHide"><para lang="zh">自动隐藏属性默认为 true</para><para lang="en">自动隐藏propertydefault is为 true</para></param>
19+
/// <param name="title"></param>
20+
/// <param name="content"></param>
21+
/// <param name="autoHide"></param>
2422
public static Task Success(this ToastService service, string? title = null, string? content = null, bool autoHide = true) => Success(service, title, content, autoHide, true);
2523

2624
/// <summary>
2725
/// <para lang="zh">Toast 调用成功快捷方法</para>
28-
/// <para lang="en">Toast 调用成功快捷方法</para>
26+
/// <para lang="en">Toast success shortcut method</para>
2927
/// </summary>
3028
/// <param name="service"></param>
31-
/// <param name="title"><para lang="zh">Title 属性</para><para lang="en">Title property</para></param>
32-
/// <param name="content"><para lang="zh">Content 属性</para><para lang="en">Content property</para></param>
33-
/// <param name="autoHide"><para lang="zh">自动隐藏属性默认为 true</para><para lang="en">自动隐藏propertydefault is为 true</para></param>
34-
/// <param name="showClose"><para lang="zh">是否显示关闭按钮 默认 true</para><para lang="en">whetherdisplay关闭button default is true</para></param>
29+
/// <param name="title"></param>
30+
/// <param name="content"></param>
31+
/// <param name="autoHide"></param>
32+
/// <param name="showClose"></param>
3533
public static Task Success(this ToastService service, string? title, string? content, bool autoHide, bool showClose) => service.Show(new ToastOption()
3634
{
3735
Category = ToastCategory.Success,
@@ -43,23 +41,23 @@ public static Task Success(this ToastService service, string? title, string? con
4341

4442
/// <summary>
4543
/// <para lang="zh">Toast 调用错误快捷方法</para>
46-
/// <para lang="en">Toast 调用错误快捷方法</para>
44+
/// <para lang="en">Toast error shortcut method</para>
4745
/// </summary>
4846
/// <param name="service"></param>
49-
/// <param name="title"><para lang="zh">Title 属性</para><para lang="en">Title property</para></param>
50-
/// <param name="content"><para lang="zh">Content 属性</para><para lang="en">Content property</para></param>
51-
/// <param name="autoHide"><para lang="zh">自动隐藏属性默认为 true</para><para lang="en">自动隐藏propertydefault is为 true</para></param>
47+
/// <param name="title"></param>
48+
/// <param name="content"></param>
49+
/// <param name="autoHide"></param>
5250
public static Task Error(this ToastService service, string? title = null, string? content = null, bool autoHide = true) => Error(service, title, content, autoHide, true);
5351

5452
/// <summary>
5553
/// <para lang="zh">Toast 调用错误快捷方法</para>
56-
/// <para lang="en">Toast 调用错误快捷方法</para>
54+
/// <para lang="en">Toast error shortcut method</para>
5755
/// </summary>
5856
/// <param name="service"></param>
59-
/// <param name="title"><para lang="zh">Title 属性</para><para lang="en">Title property</para></param>
60-
/// <param name="content"><para lang="zh">Content 属性</para><para lang="en">Content property</para></param>
61-
/// <param name="autoHide"><para lang="zh">自动隐藏属性默认为 true</para><para lang="en">自动隐藏propertydefault is为 true</para></param>
62-
/// <param name="showClose"><para lang="zh">是否显示关闭按钮 默认 true</para><para lang="en">whetherdisplay关闭button default is true</para></param>
57+
/// <param name="title"></param>
58+
/// <param name="content"></param>
59+
/// <param name="autoHide"></param>
60+
/// <param name="showClose"></param>
6361
public static Task Error(this ToastService service, string? title, string? content, bool autoHide, bool showClose) => service.Show(new ToastOption()
6462
{
6563
Category = ToastCategory.Error,
@@ -71,23 +69,23 @@ public static Task Error(this ToastService service, string? title, string? conte
7169

7270
/// <summary>
7371
/// <para lang="zh">Toast 调用提示信息快捷方法</para>
74-
/// <para lang="en">Toast 调用提示信息快捷方法</para>
72+
/// <para lang="en">Toast information shortcut method</para>
7573
/// </summary>
7674
/// <param name="service"></param>
77-
/// <param name="title"><para lang="zh">Title 属性</para><para lang="en">Title property</para></param>
78-
/// <param name="content"><para lang="zh">Content 属性</para><para lang="en">Content property</para></param>
79-
/// <param name="autoHide"><para lang="zh">自动隐藏属性默认为 true</para><para lang="en">自动隐藏propertydefault is为 true</para></param>
75+
/// <param name="title"></param>
76+
/// <param name="content"></param>
77+
/// <param name="autoHide"></param>
8078
public static Task Information(this ToastService service, string? title = null, string? content = null, bool autoHide = true) => Information(service, title, content, autoHide, true);
8179

8280
/// <summary>
8381
/// <para lang="zh">Toast 调用提示信息快捷方法</para>
84-
/// <para lang="en">Toast 调用提示信息快捷方法</para>
82+
/// <para lang="en">Toast information shortcut method</para>
8583
/// </summary>
8684
/// <param name="service"></param>
87-
/// <param name="title"><para lang="zh">Title 属性</para><para lang="en">Title property</para></param>
88-
/// <param name="content"><para lang="zh">Content 属性</para><para lang="en">Content property</para></param>
89-
/// <param name="autoHide"><para lang="zh">自动隐藏属性默认为 true</para><para lang="en">自动隐藏propertydefault is为 true</para></param>
90-
/// <param name="showClose"><para lang="zh">是否显示关闭按钮 默认 true</para><para lang="en">whetherdisplay关闭button default is true</para></param>
85+
/// <param name="title"></param>
86+
/// <param name="content"></param>
87+
/// <param name="autoHide"></param>
88+
/// <param name="showClose"></param>
9189
public static Task Information(this ToastService service, string? title, string? content, bool autoHide, bool showClose) => service.Show(new ToastOption()
9290
{
9391
Category = ToastCategory.Information,
@@ -99,23 +97,23 @@ public static Task Information(this ToastService service, string? title, string?
9997

10098
/// <summary>
10199
/// <para lang="zh">Toast 调用警告信息快捷方法</para>
102-
/// <para lang="en">Toast 调用警告信息快捷方法</para>
100+
/// <para lang="en">Toast warning shortcut method</para>
103101
/// </summary>
104102
/// <param name="service"></param>
105-
/// <param name="title"><para lang="zh">Title 属性</para><para lang="en">Title property</para></param>
106-
/// <param name="content"><para lang="zh">Content 属性</para><para lang="en">Content property</para></param>
107-
/// <param name="autoHide"><para lang="zh">自动隐藏属性默认为 true</para><para lang="en">自动隐藏propertydefault is为 true</para></param>
103+
/// <param name="title"></param>
104+
/// <param name="content"></param>
105+
/// <param name="autoHide"></param>
108106
public static Task Warning(this ToastService service, string? title = null, string? content = null, bool autoHide = true) => Warning(service, title, content, autoHide, true);
109107

110108
/// <summary>
111109
/// <para lang="zh">Toast 调用警告信息快捷方法</para>
112-
/// <para lang="en">Toast 调用警告信息快捷方法</para>
110+
/// <para lang="en">Toast warning shortcut method</para>
113111
/// </summary>
114112
/// <param name="service"></param>
115-
/// <param name="title"><para lang="zh">Title 属性</para><para lang="en">Title property</para></param>
116-
/// <param name="content"><para lang="zh">Content 属性</para><para lang="en">Content property</para></param>
117-
/// <param name="autoHide"><para lang="zh">自动隐藏属性默认为 true</para><para lang="en">自动隐藏propertydefault is为 true</para></param>
118-
/// <param name="showClose"><para lang="zh">是否显示关闭按钮 默认 true</para><para lang="en">whetherdisplay关闭button default is true</para></param>
113+
/// <param name="title"></param>
114+
/// <param name="content"></param>
115+
/// <param name="autoHide"></param>
116+
/// <param name="showClose"></param>
119117
public static Task Warning(this ToastService service, string? title, string? content, bool autoHide, bool showClose) => service.Show(new ToastOption()
120118
{
121119
Category = ToastCategory.Warning,

0 commit comments

Comments
 (0)