Skip to content

Commit 04cff2b

Browse files
ArgoZhangArgoZhang
authored
doc(Extensions): update Drawer extensions method comments (#7840)
* doc(DrawerExtensions): update comments * doc(DrawerOptionExtensions): update documentation * doc(DrawerServiceExtensions): update comments * doc(DynamicObjectContextExtensions): update comments
1 parent 3c468b6 commit 04cff2b

File tree

4 files changed

+152
-38
lines changed

4 files changed

+152
-38
lines changed

‎src/BootstrapBlazor/Extensions/DrawerExtensions.cs‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,18 @@ public static class DrawerExtensions
1515
/// <para lang="zh">弹出编辑抽屉</para>
1616
/// <para lang="en">Show edit drawer</para>
1717
/// </summary>
18-
/// <param name="service"><para lang="zh"><see cref="DrawerService"/> 服务实例</para><para lang="en"><see cref="DrawerService"/> instance</para></param>
19-
/// <param name="editDialogOption"><para lang="zh"><see cref="ITableEditDialogOption{TModel}"/> 配置类实例</para><para lang="en"><see cref="ITableEditDialogOption{TModel}"/> option instance</para></param>
20-
/// <param name="option"><para lang="zh"><see cref="DrawerOption"/> 配置类实例</para><para lang="en"><see cref="DrawerOption"/> option instance</para></param>
18+
/// <param name="service">
19+
/// <para lang="zh"><see cref="DrawerService"/> 服务实例</para>
20+
/// <para lang="en"><see cref="DrawerService"/> instance</para>
21+
/// </param>
22+
/// <param name="editDialogOption">
23+
/// <para lang="zh"><see cref="ITableEditDialogOption{TModel}"/> 配置类实例</para>
24+
/// <para lang="en"><see cref="ITableEditDialogOption{TModel}"/> option instance</para>
25+
/// </param>
26+
/// <param name="option">
27+
/// <para lang="zh"><see cref="DrawerOption"/> 配置类实例</para>
28+
/// <para lang="en"><see cref="DrawerOption"/> option instance</para>
29+
/// </param>
2130
public static async Task ShowEditDrawer<TModel>(this DrawerService service, TableEditDrawerOption<TModel> editDialogOption, DrawerOption option)
2231
{
2332
var parameters = editDialogOption.ToParameter();

‎src/BootstrapBlazor/Extensions/DrawerOptionExtensions.cs‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ public static class DrawerOptionExtensions
1515
/// <para lang="zh">获得 组件渲染块</para>
1616
/// <para lang="en">Get component render fragment</para>
1717
/// </summary>
18-
/// <param name="drawerOption"></param>
18+
/// <param name="drawerOption">
19+
/// <para lang="zh"><see cref="DrawerOption"/> 实例</para>
20+
/// <para lang="en"><see cref="DrawerOption"/> instance</para>
21+
/// </param>
1922
public static RenderFragment? GetContent(this DrawerOption drawerOption) => drawerOption.ChildContent ?? drawerOption.Component?.Render();
2023
}

‎src/BootstrapBlazor/Extensions/DrawerServiceExtensions.cs‎

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,18 @@ public static class DrawerServiceExtensions
1515
/// <para lang="zh">弹出搜索对话框</para>
1616
/// <para lang="en">Show search dialog</para>
1717
/// </summary>
18-
/// <param name="service"><para lang="zh">DrawerService 服务实例</para><para lang="en">DrawerService instance</para></param>
19-
/// <param name="parameters"></param>
20-
/// <param name="option"><para lang="zh">DrawerOption 配置类实例</para><para lang="en">DrawerOption instance</para></param>
18+
/// <param name="service">
19+
/// <para lang="zh">DrawerService 服务实例</para>
20+
/// <para lang="en">DrawerService instance</para>
21+
/// </param>
22+
/// <param name="parameters">
23+
/// <para lang="zh">组件参数字典</para>
24+
/// <para lang="en">Component parameters dictionary</para>
25+
/// </param>
26+
/// <param name="option">
27+
/// <para lang="zh">DrawerOption 配置类实例</para>
28+
/// <para lang="en">DrawerOption instance</para>
29+
/// </param>
2130
public static async Task Show<TComponent>(this DrawerService service, DrawerOption? option = null, IDictionary<string, object?>? parameters = null) where TComponent : IComponent
2231
{
2332
option ??= new DrawerOption();
@@ -29,10 +38,22 @@ public static async Task Show<TComponent>(this DrawerService service, DrawerOpti
2938
/// <para lang="zh">弹出搜索对话框</para>
3039
/// <para lang="en">Show search dialog</para>
3140
/// </summary>
32-
/// <param name="service"><para lang="zh">DrawerService 服务实例</para><para lang="en">DrawerService instance</para></param>
33-
/// <param name="type"></param>
34-
/// <param name="parameters"></param>
35-
/// <param name="option"><para lang="zh">DrawerOption 配置类实例</para><para lang="en">DrawerOption instance</para></param>
41+
/// <param name="service">
42+
/// <para lang="zh">DrawerService 服务实例</para>
43+
/// <para lang="en">DrawerService instance</para>
44+
/// </param>
45+
/// <param name="type">
46+
/// <para lang="zh">组件类型</para>
47+
/// <para lang="en">Component type</para>
48+
/// </param>
49+
/// <param name="parameters">
50+
/// <para lang="zh">组件参数字典</para>
51+
/// <para lang="en">Component parameters dictionary</para>
52+
/// </param>
53+
/// <param name="option">
54+
/// <para lang="zh">DrawerOption 配置类实例</para>
55+
/// <para lang="en">DrawerOption instance</para>
56+
/// </param>
3657
public static async Task Show(this DrawerService service, Type type, DrawerOption? option = null, IDictionary<string, object?>? parameters = null)
3758
{
3859
option ??= new DrawerOption();

‎src/BootstrapBlazor/Extensions/DynamicObjectContextExtensions.cs‎

Lines changed: 108 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,22 @@ public static class DynamicObjectContextExtensions
1818
/// <para lang="zh">增加 RequiredAttribute 扩展方法</para>
1919
/// <para lang="en">Add RequiredAttribute Extension</para>
2020
/// </summary>
21-
/// <param name="context"></param>
22-
/// <param name="columnName"></param>
23-
/// <param name="errorMessage"></param>
24-
/// <param name="allowEmptyStrings"></param>
21+
/// <param name="context">
22+
/// <para lang="zh">DynamicObjectContext 实例</para>
23+
/// <para lang="en">DynamicObjectContext instance</para>
24+
/// </param>
25+
/// <param name="columnName">
26+
/// <para lang="zh">列名</para>
27+
/// <para lang="en">Column name</para>
28+
/// </param>
29+
/// <param name="errorMessage">
30+
/// <para lang="zh">错误信息</para>
31+
/// <para lang="en">Error message</para>
32+
/// </param>
33+
/// <param name="allowEmptyStrings">
34+
/// <para lang="zh">是否允许空字符串</para>
35+
/// <para lang="en">Whether to allow empty strings</para>
36+
/// </param>
2537
public static void AddRequiredAttribute(this DynamicObjectContext context, string columnName, string? errorMessage = null, bool allowEmptyStrings = false)
2638
{
2739
var parameters = new KeyValuePair<string, object?>[]
@@ -36,28 +48,55 @@ public static void AddRequiredAttribute(this DynamicObjectContext context, strin
3648
/// <para lang="zh">增加 AutoGenerateColumnAttribute 扩展方法</para>
3749
/// <para lang="en">Add AutoGenerateColumnAttribute Extension</para>
3850
/// </summary>
39-
/// <param name="context"></param>
40-
/// <param name="columnName"></param>
41-
/// <param name="parameters"></param>
51+
/// <param name="context">
52+
/// <para lang="zh">DynamicObjectContext 实例</para>
53+
/// <para lang="en">DynamicObjectContext instance</para>
54+
/// </param>
55+
/// <param name="columnName">
56+
/// <para lang="zh">列名</para>
57+
/// <para lang="en">Column name</para>
58+
/// </param>
59+
/// <param name="parameters">
60+
/// <para lang="zh">参数字典</para>
61+
/// <para lang="en">Parameters dictionary</para>
62+
/// </param>
4263
public static void AddAutoGenerateColumnAttribute(this DynamicObjectContext context, string columnName, IEnumerable<KeyValuePair<string, object?>> parameters) => context.AddMultipleParameterAttribute<AutoGenerateColumnAttribute>(columnName, parameters);
4364

4465
/// <summary>
4566
/// <para lang="zh">增加 DisplayAttribute 扩展方法</para>
4667
/// <para lang="en">Add DisplayAttribute Extension</para>
4768
/// </summary>
48-
/// <param name="context"></param>
49-
/// <param name="columnName"></param>
50-
/// <param name="parameters"></param>
69+
/// <param name="context">
70+
/// <para lang="zh">DynamicObjectContext 实例</para>
71+
/// <para lang="en">DynamicObjectContext instance</para>
72+
/// </param>
73+
/// <param name="columnName">
74+
/// <para lang="zh">列名</para>
75+
/// <para lang="en">Column name</para>
76+
/// </param>
77+
/// <param name="parameters">
78+
/// <para lang="zh">参数字典</para>
79+
/// <para lang="en">Parameters dictionary</para>
80+
/// </param>
5181
public static void AddDisplayAttribute(this DynamicObjectContext context, string columnName, IEnumerable<KeyValuePair<string, object?>> parameters) => context.AddMultipleParameterAttribute<DisplayAttribute>(columnName, parameters);
5282

5383
/// <summary>
5484
/// <para lang="zh">增加多参数自定义标签泛型方法</para>
5585
/// <para lang="en">Add multiple reference custom labels common method</para>
5686
/// </summary>
5787
/// <typeparam name="TAttribute"></typeparam>
58-
/// <param name="context"></param>
59-
/// <param name="columnName"></param>
60-
/// <param name="parameters"></param>
88+
/// <param name="context">
89+
/// <para lang="zh">DynamicObjectContext 实例</para>
90+
/// <para lang="en">DynamicObjectContext instance</para>
91+
/// </param>
92+
/// <param name="columnName">
93+
/// <para lang="zh">列名</para>
94+
/// <para lang="en">Column name</para>
95+
/// </param>
96+
/// <param name="parameters">
97+
/// <para lang="zh">参数字典</para>
98+
/// <para lang="en">Parameters dictionary</para>
99+
/// </param>
61100
public static void AddMultipleParameterAttribute<TAttribute>(this DynamicObjectContext context, string columnName, IEnumerable<KeyValuePair<string, object?>> parameters) where TAttribute : Attribute
62101
{
63102
var type = typeof(TAttribute);
@@ -79,31 +118,67 @@ public static void AddMultipleParameterAttribute<TAttribute>(this DynamicObjectC
79118
/// <para lang="zh">增加 DisplayNameAttribute 扩展方法</para>
80119
/// <para lang="en">Add DisplayNameAttribute Extension</para>
81120
/// </summary>
82-
/// <param name="context"></param>
83-
/// <param name="columnName"></param>
84-
/// <param name="displayName"></param>
121+
/// <param name="context">
122+
/// <para lang="zh">DynamicObjectContext 实例</para>
123+
/// <para lang="en">DynamicObjectContext instance</para>
124+
/// </param>
125+
/// <param name="columnName">
126+
/// <para lang="zh">列名</para>
127+
/// <para lang="en">Column name</para>
128+
/// </param>
129+
/// <param name="displayName">
130+
/// <para lang="zh">显示名称</para>
131+
/// <para lang="en">Display name</para>
132+
/// </param>
85133
public static void AddDisplayNameAttribute(this DynamicObjectContext context, string columnName, string displayName) => context.AddAttribute<DisplayNameAttribute>(columnName, [typeof(string)], [displayName]);
86134

87135
/// <summary>
88136
/// <para lang="zh">增加 DescriptionAttribute 扩展方法</para>
89137
/// <para lang="en">Add DescriptionAttribute Extension</para>
90138
/// </summary>
91-
/// <param name="context"></param>
92-
/// <param name="columnName"></param>
93-
/// <param name="description"></param>
139+
/// <param name="context">
140+
/// <para lang="zh">DynamicObjectContext 实例</para>
141+
/// <para lang="en">DynamicObjectContext instance</para>
142+
/// </param>
143+
/// <param name="columnName">
144+
/// <para lang="zh">列名</para>
145+
/// <para lang="en">Column name</para>
146+
/// </param>
147+
/// <param name="description">
148+
/// <para lang="zh">描述</para>
149+
/// <para lang="en">Description</para>
150+
/// </param>
94151
public static void AddDescriptionAttribute(this DynamicObjectContext context, string columnName, string description) => context.AddAttribute<DescriptionAttribute>(columnName, [typeof(string)], [description]);
95152

96153
/// <summary>
97154
/// <para lang="zh">增加自定义标签泛型方法</para>
98155
/// <para lang="en">Add Custom Attribute Generic Method</para>
99156
/// </summary>
100157
/// <typeparam name="TAttribute"></typeparam>
101-
/// <param name="context"></param>
102-
/// <param name="columnName"></param>
103-
/// <param name="types"></param>
104-
/// <param name="constructorArgs"></param>
105-
/// <param name="propertyInfos"></param>
106-
/// <param name="propertyValues"></param>
158+
/// <param name="context">
159+
/// <para lang="zh">DynamicObjectContext 实例</para>
160+
/// <para lang="en">DynamicObjectContext instance</para>
161+
/// </param>
162+
/// <param name="columnName">
163+
/// <para lang="zh">列名</para>
164+
/// <para lang="en">Column name</para>
165+
/// </param>
166+
/// <param name="types">
167+
/// <para lang="zh">构造函数参数类型数组</para>
168+
/// <para lang="en">Array of constructor parameter types</para>
169+
/// </param>
170+
/// <param name="constructorArgs">
171+
/// <para lang="zh">构造函数参数值数组</para>
172+
/// <para lang="en">Array of constructor parameter values</para>
173+
/// </param>
174+
/// <param name="propertyInfos">
175+
/// <para lang="zh">属性信息数组</para>
176+
/// <para lang="en">Array of property information</para>
177+
/// </param>
178+
/// <param name="propertyValues">
179+
/// <para lang="zh">属性值数组</para>
180+
/// <para lang="en">Array of property values</para>
181+
/// </param>
107182
public static void AddAttribute<TAttribute>(this DynamicObjectContext context, string columnName, Type[] types, object?[] constructorArgs, PropertyInfo[]? propertyInfos = null, object?[]? propertyValues = null) where TAttribute : Attribute
108183
{
109184
var type = typeof(TAttribute);
@@ -114,8 +189,14 @@ public static void AddAttribute<TAttribute>(this DynamicObjectContext context, s
114189
/// <para lang="zh">扩展方法将指定模型赋值给 context 实例</para>
115190
/// <para lang="en">Extension method allows assigning a specified model to a context instance</para>
116191
/// </summary>
117-
/// <param name="context"><para lang="zh">DynamicObjectContext 实例</para><para lang="en">DynamicObjectContext instance</para></param>
118-
/// <param name="model"><para lang="zh">模型实例</para><para lang="en">Model instance</para></param>
192+
/// <param name="context">
193+
/// <para lang="zh">DynamicObjectContext 实例</para>
194+
/// <para lang="en">DynamicObjectContext instance</para>
195+
/// </param>
196+
/// <param name="model">
197+
/// <para lang="zh">模型实例</para>
198+
/// <para lang="en">Model instance</para>
199+
/// </param>
119200
public static async Task SetValue(this IDynamicObjectContext context, object model)
120201
{
121202
if (model is IDynamicObject v)

0 commit comments

Comments
 (0)