Conversation
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates documentation comments across various components by removing <para><version>10.2.2</version></para> tags and <returns></returns> tags from XML documentation. The changes are purely cosmetic, improving code cleanliness by removing redundant version metadata and unnecessary return documentation tags for methods where the return behavior is self-evident from the signature or <inheritdoc/> usage.
Changes:
- Removed version tags (
<para><version>10.2.2</version></para>) from component parameters and methods - Removed empty or redundant
<returns></returns>tags from method documentation - Minor improvements to documentation text (e.g., fixing typos, improving clarity)
Reviewed changes
Copilot reviewed 275 out of 523 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| Table.razor.Sort.cs | Removed version and returns tags from sorting-related parameters and methods |
| Table.razor.Search.cs | Removed version and returns tags from search-related parameters and methods |
| Table.razor.Pagination.cs | Removed version and returns tags from pagination parameters and methods |
| Table.razor.Localization.cs | Removed version tags from localization text parameters |
| Table.razor.Edit.cs | Removed version and returns tags from edit-related parameters and methods |
| Table.razor.Checkbox.cs | Removed version tags from checkbox selection parameters |
| LookupContent.cs | Removed version tag from Value parameter |
| IToolbarComponent.cs | Removed version tag from IsShow property |
| ITableToolbarButton.cs | Removed version tags from interface properties |
| ITableSearchModel.cs | Removed version tags from interface methods |
| ITableExportDataContext.cs | Removed version tags from interface properties |
| ITableExportContext.cs | Removed version tags from interface methods |
| ITableEditDialogOption.cs | Removed version tags from interface properties |
| ITableColumn.cs | Removed version tags from interface properties |
| TabToolbarButton.razor.cs | Removed version tags from button parameters |
| TabLink.razor.cs | Removed version tags from link parameters |
| TabItemContent.cs | Removed version tag from Item parameter |
| TabItem.cs | Removed version tags from tab item properties |
| Tab.razor.cs | Removed version and returns tags from tab component parameters and methods |
| BootstrapBlazorAuthorizeView.cs | Removed version tags from authorization view parameters |
| Switch.razor.cs | Removed version tags from switch component parameters |
| NullSwitch.razor.cs | Removed version tags from nullable switch parameters |
| SweetAlertBody.razor.cs | Removed version tags from sweet alert body parameters |
| SweetAlert.razor.cs | Removed returns tag from OnAfterRenderAsync |
| SwalOption.cs | Removed returns tag from ToAttributes method |
| StepItem.cs | Removed version tags from step item properties |
| Step.razor.cs | Removed version and returns tags from step component |
| StackItem.cs | Removed version tags from stack item properties |
| Stack.razor.cs | Removed version tags from stack layout parameters |
| Split.razor.cs | Removed version and returns tags from split panel parameters and methods |
| Spinner.razor.cs | Removed version tags from spinner parameters |
| SynthesizerService.cs | Removed returns tag from InvokeAsync method |
| SpeechWave.razor.cs | Removed version and returns tags, improved documentation text |
| RecognizerService.cs | Removed returns tag from InvokeAsync method |
| RecognizerOption.cs | Added corrected property for misspelled AutoRecoginzerElapsedMilliseconds |
| ISynthesizerProvider.cs | Removed returns tag from InvokeAsync |
| IRecognizerProvider.cs | Removed returns tag and improved interface description |
| Slider.razor.cs | Removed version tags and improved component description |
| SkeletonTree.razor.cs | Removed version tag from Icon parameter |
| SkeletonTable.razor.cs | Removed version tags from table skeleton parameters |
| SkeletonBase.cs | Removed version tags and improved documentation |
| SkeletonAvatar.razor.cs | Removed version tag and improved component description |
| SelectGeneric components | Removed version and returns tags, improved Chinese translations |
| Select components | Removed version and returns tags, improved documentation clarity |
| MultiSelect components | Removed version and returns tags, improved Chinese translations |
| SelectOption.cs | Removed version tags and improved Chinese translations |
| SelectBase.cs | Removed version tags and improved Chinese translations |
| PopoverSelectBase.cs | Removed version tags from popover parameters |
| SegmentedOption.cs | Improved ChildContent documentation |
| SegmentedItem.cs | Removed version tags and improved Dispose documentation |
| Segmented.razor.cs | Removed version and returns tags |
| Search.razor.cs | Removed version tags and improved Chinese translations |
| Scroll.razor.cs | Removed version tags from scroll parameters |
| Responsive.cs | Removed version and returns tags, improved documentation clarity |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| /// <para lang="en">Gets or sets Auto Recognition Time. Default 5000. Set 0 to disable and need to close manually</para> | ||
| /// </summary> | ||
| public int AutoRecoginzerElapsedMilliseconds { get; set; } = 5000; | ||
| [Obsolete("已弃用，请使用 AutoRecognizerElapsedMilliseconds 属性单词拼写错误。 Deprecated. Please use the AutoRecognizerElapsedMilliseconds method. (The word is misspelled.)")] |
There was a problem hiding this comment.
The obsolete message refers to 'method' but should refer to 'property' since AutoRecognizerElapsedMilliseconds is a property, not a method.
Suggested change
| [Obsolete("已弃用，请使用 AutoRecognizerElapsedMilliseconds 属性单词拼写错误。 Deprecated. Please use the AutoRecognizerElapsedMilliseconds method. (The word is misspelled.)")] | |
| [Obsolete("已弃用，请使用 AutoRecognizerElapsedMilliseconds 属性单词拼写错误。 Deprecated. Please use the AutoRecognizerElapsedMilliseconds property. (The word is misspelled.)")] |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7552 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 748 748
Lines 33000 33000
Branches 4588 4588
=========================================
Hits 33000 33000
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Link issues
fixes #7551
Summary By Copilot
Regression?
Risk
Verification
Packaging changes reviewed?
☑️ Self Check before Merge