-
-
Notifications
You must be signed in to change notification settings - Fork 381
doc(Comments): update components xml comments #7745
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,54 +7,50 @@ namespace BootstrapBlazor.Components; | |
|
|
||
| /// <summary> | ||
| /// <para lang="zh">Marquee 字幕滚动组件</para> | ||
| /// <para lang="en">Marquee 字幕滚动component</para> | ||
| /// <para lang="en">Marquee scrolling component</para> | ||
| /// </summary> | ||
| public partial class Marquee | ||
| { | ||
| /// <summary> | ||
| /// <para lang="zh">获得/设置 组件值 显示文本 默认 Empty</para> | ||
| /// <para lang="en">Gets or sets component值 display文本 Default is Empty</para> | ||
| /// <para lang="en">Gets or sets the component's display text. Default is Empty.</para> | ||
| /// </summary> | ||
| [Parameter] | ||
| public string? Text { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// <para lang="zh">获得/设置 组件值 文本颜色 默认 #000 <para>支持16进制和颜色名称</para> | ||
| ///</para> | ||
| /// <para lang="en">Gets or sets component值 文本color Default is #000 <para>支持16进制和color名称</para> | ||
| ///</para> | ||
| /// <para lang="zh">获得/设置 组件值 文本颜色 默认 #000 支持16进制和颜色名称</para> | ||
| /// <para lang="en">Gets or sets the component's text color. Default is #000 Supports hexadecimal and color names</para> | ||
| /// </summary> | ||
|
Comment on lines
21
to
24
|
||
| [Parameter] | ||
| public string Color { get; set; } = "#000"; | ||
|
|
||
| /// <summary> | ||
| /// <para lang="zh">获得/设置 组件值 背景颜色 默认 #fff <para>支持16进制和颜色名称</para> | ||
| ///</para> | ||
| /// <para lang="en">Gets or sets component值 背景color Default is #fff <para>支持16进制和color名称</para> | ||
| ///</para> | ||
| /// <para lang="zh">获得/设置 组件值 背景颜色 默认 #fff 支持16进制和颜色名称</para> | ||
| /// <para lang="en">Gets or sets the component's background color. Default is #fff Supports hexadecimal and color names</para> | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nitpick (typo): Minor grammar issue in the English description of the background color parameter. You could mirror the text color description and update this to: Suggested implementation: /// <summary>
/// <para lang="zh">获得/设置 组件值 背景颜色 默认 #fff 支持16进制和颜色名称</para>
/// <para lang="en">Gets or sets the component's background color. Default is #fff. Supports hexadecimal and color names.</para>
/// </summary>
[Parameter]
public string? Text { get; set; }
/// <summary>
/// <para lang="zh">获得/设置 组件值 文本颜色 默认 #000 支持16进制和颜色名称</para>
/// <para lang="en">Gets or sets the component's text color. Default is #000. Supports hexadecimal and color names.</para>
/// </summary>If the |
||
| /// </summary> | ||
|
Comment on lines
28
to
31
|
||
| [Parameter] | ||
| public string BackgroundColor { get; set; } = "#fff"; | ||
|
|
||
| /// <summary> | ||
| /// <para lang="zh">获得/设置 组件值 文本大小 默认 72px</para> | ||
| /// <para lang="en">Gets or sets component值 文本大小 Default is 72px</para> | ||
| /// <para lang="en">Gets or sets the component's text size. Default is 72px</para> | ||
| /// </summary> | ||
| [Parameter] | ||
| public int FontSize { get; set; } = 72; | ||
|
|
||
| /// <summary> | ||
| /// <para lang="zh">获得/设置 组件值 动画时间 默认 14s <para>值越小滚动越快</para> | ||
| ///</para> | ||
| /// <para lang="en">Gets or sets component值 动画时间 Default is 14s <para>值越小滚动越快</para> | ||
| /// <para lang="en">Gets or sets the component's animation duration. Default is 14s <para>The smaller the value, the faster the scroll</para> | ||
| ///</para> | ||
|
Comment on lines
42
to
46
|
||
| /// </summary> | ||
| [Parameter] | ||
| public int Duration { get; set; } = 14; | ||
|
|
||
| /// <summary> | ||
| /// <para lang="zh">获得/设置 组件值 滚动方向 默认 LeftToRight</para> | ||
| /// <para lang="en">Gets or sets component值 滚动方向 Default is LeftToRight</para> | ||
| /// <para lang="en">Gets or sets the component's scroll direction. Default is LeftToRight</para> | ||
| /// </summary> | ||
| [Parameter] | ||
| public MarqueeDirection Direction { get; set; } | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -33,13 +33,9 @@ public partial class Message | |
| [Parameter] | ||
| public Placement Placement { get; set; } = Placement.Top; | ||
|
|
||
| /// <summary> | ||
| /// <para lang="zh">ToastServices 服务实例</para> | ||
| /// <para lang="en">MessageService Service Instance</para> | ||
| /// </summary> | ||
| [Inject] | ||
| [NotNull] | ||
| public MessageService? MessageService { get; set; } | ||
| private MessageService? MessageService { get; set; } | ||
|
Comment on lines
36
to
+38
|
||
|
|
||
| /// <summary> | ||
| /// <inheritdoc/> | ||
|
|
@@ -92,7 +88,6 @@ protected override async Task OnAfterRenderAsync(bool firstRender) | |
| /// <para lang="zh">设置 容器位置方法</para> | ||
| /// <para lang="en">Set Container Placement Method</para> | ||
| /// </summary> | ||
| /// <param name="placement"></param> | ||
| public void SetPlacement(Placement placement) | ||
| { | ||
| Placement = placement; | ||
|
|
@@ -134,7 +129,6 @@ public void Clear(string id) | |
| /// <para lang="zh">OnDismiss 回调方法 由 JSInvoke 触发</para> | ||
| /// <para lang="en">OnDismiss Callback Method. Triggered by JSInvoke</para> | ||
| /// </summary> | ||
| /// <param name="id"></param> | ||
| [JSInvokable] | ||
| public async ValueTask Dismiss(string id) | ||
| { | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nitpick (typo): Minor grammar issue in the English description of the text color parameter.
Add punctuation to clearly separate the default value from the capability description, e.g.
Default is #000. Supports hexadecimal and color names.