[MCP] Improve [Parameter] XML doc comments — Group C: Data Display#4822
Open
AClerbois wants to merge 10 commits intomicrosoft:dev-v5from
Open
[MCP] Improve [Parameter] XML doc comments — Group C: Data Display#4822AClerbois wants to merge 10 commits intomicrosoft:dev-v5from
AClerbois wants to merge 10 commits intomicrosoft:dev-v5from
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Improves XML doc comments for [Parameter] properties across data display-related components to provide clearer, more accurate descriptions for MCP/IntelliSense consumers.
Changes:
- Clarifies TreeView selection-related parameter docs and adds cross-references between related parameters.
- Rewrites/normalizes several parameter summaries to “Gets or sets …” phrasing and corrects grammar/typos.
- Improves parameter descriptions for Overflow, Paginator, Autocomplete/List, and DataGrid/Column docs.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Core/Components/TreeView/FluentTreeView.razor.cs | Clarifies selection parameters and adds “See also” cross-references between related selection properties. |
| src/Core/Components/Pagination/FluentPaginator.razor.cs | Normalizes Disabled parameter summary to declarative “Gets or sets …” phrasing. |
| src/Core/Components/Overflow/FluentOverflow.razor.cs | Clarifies VisibleOnLoad behavior/default and improves UseTooltipService summary grammar. |
| src/Core/Components/List/FluentListBase.razor.cs | Fixes “binded” → “bound” typo in parameter documentation. |
| src/Core/Components/List/FluentAutocomplete.razor.cs | Disambiguates ShowDismiss behavior between dismiss button vs search icon. |
| src/Core/Components/DataGrid/FluentDataGrid.razor.cs | Fixes typo “rid” → “grid” in data callback summary. |
| src/Core/Components/DataGrid/Columns/ColumnBase.razor.cs | Improves multiple column parameter docs with clearer wording, examples, and cross-refs. |
Comment on lines
+87
to
+88
| /// See also <see cref="SelectedItem"/> (returns the <see cref="ITreeViewItem"/> data model) | ||
| /// and <see cref="CurrentSelected"/> (returns the <see cref="FluentTreeItem"/> component instance). |
Comment on lines
+100
to
+102
| /// Gets or sets the selected <see cref="FluentTreeItem"/> component instance. | ||
| /// See also <see cref="SelectedId"/> (returns the item id string) | ||
| /// and <see cref="SelectedItem"/> (returns the <see cref="ITreeViewItem"/> data model). |
Comment on lines
+114
to
+116
| /// Gets or sets the selected <see cref="ITreeViewItem"/> data model item. | ||
| /// See also <see cref="SelectedId"/> (returns the item id string) | ||
| /// and <see cref="CurrentSelected"/> (returns the <see cref="FluentTreeItem"/> component instance). |
|
|
||
| /// <summary> | ||
| /// If true, generates a title and aria-label attribute for the cell contents | ||
| /// Gets or sets whether each cell in this column renders a <c>title</c> and <c>aria-label</c> attribute |
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.
Summary
Improves XML doc comments on
[Parameter]properties in data display components so the MCP server serves accurate descriptions to AI models.Components
ShowDismissambiguousHideSelectiondouble-negative, selection props missing cross-refsDisabledimperative style → declarativeVisibleOnLoadimperative style,UseTooltipServicegrammarPart of
Part of #4777