[MCP] Improve [Parameter] XML doc comments — Group A: Input Controls#4821
Open
AClerbois wants to merge 10 commits intomicrosoft:dev-v5from
Open
[MCP] Improve [Parameter] XML doc comments — Group A: Input Controls#4821AClerbois 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.
This PR updates XML documentation comments across text, checkbox, radio, and button-related components so MCP exposes clearer parameter descriptions to AI consumers.
Changes:
- Clarifies template, autocomplete, and sizing docs for text input and textarea components.
- Improves checkbox and radio-group parameter summaries, including three-state and item label/value helpers.
- Rewrites button-family docs for validation, disabled-focusable, icon-only, label, and description parameters.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Core/Components/TextInput/FluentTextInput.razor.cs | Clarifies StartTemplate, EndTemplate, and AutoComplete XML docs. |
| src/Core/Components/TextArea/FluentTextArea.razor.cs | Updates textarea summary, constructor docs, autocomplete, sizing, and resize comments. |
| src/Core/Components/Radio/FluentRadioGroup.razor.cs | Adds missing Items summary and improves radio item helper docs. |
| src/Core/Components/Checkbox/FluentCheckbox.razor.cs | Refines CheckState docs and adjusts constructor XML summary. |
| src/Core/Components/Button/FluentSplitButton.razor.cs | Revises split-button IconOnly and Label docs. |
| src/Core/Components/Button/FluentCompoundButton.razor.cs | Revises compound-button IconOnly, Label, and Description docs. |
| src/Core/Components/Button/FluentButton.razor.cs | Updates FormNoValidate, DisabledFocusable, IconOnly, and Label docs. |
| src/Core/Components/Button/FluentAnchorButton.razor.cs | Revises anchor-button IconOnly and Label docs. |
|
|
||
| /// <summary> | ||
| /// Gets or sets the how resize the element. See <see cref="Components.TextAreaResize"/> | ||
| /// Gets or sets how the textarea can be resized by the user. See <see cref="Components.TextAreaResize"/>. |
| /// Gets or sets if the button only shows an icon | ||
| /// Can be used when using <see cref="ChildContent"/> that renders as an icon | ||
| /// Gets or sets a value indicating whether the button renders icon-only (no visible text label). | ||
| /// Typically used when <see cref="IconStart"/> or <see cref="IconEnd"/> is set and no text label is needed. |
| /// Gets or sets if the button only shows an icon | ||
| /// Can be used when using <see cref="ChildContent"/> that renders as an icon | ||
| /// Gets or sets a value indicating whether the button renders icon-only (no visible text label). | ||
| /// Typically used when <see cref="IconStart"/> or <see cref="IconEnd"/> is set and no text label is needed. |
| /// Gets or sets if the button only shows an icon | ||
| /// Can be used when using <see cref="ChildContent"/> that renders as an icon | ||
| /// Gets or sets a value indicating whether the button renders icon-only (no visible text label). | ||
| /// Typically used when <see cref="IconStart"/> is set and no text label is needed. |
| /// Gets or sets if the button only shows an icon | ||
| /// Can be used when using <see cref="ChildContent"/> that renders as an icon | ||
| /// Gets or sets a value indicating whether the button renders icon-only (no visible text label). | ||
| /// Typically used when <see cref="IconStart"/> or <see cref="IconEnd"/> is set and no text label is needed. |
Comment on lines
+133
to
+135
| /// Gets or sets the plain-text label rendered inside the button (e.g., <c>Label="Go"</c>). | ||
| /// For rich content such as icons or custom markup, use <see cref="ChildContent"/> instead. | ||
| /// </summary> |
Comment on lines
+100
to
+102
| /// Gets or sets the plain-text label rendered inside the primary button area (e.g., <c>Label="Save"</c>). | ||
| /// For rich content such as icons or custom markup, use <see cref="ChildContent"/> instead. | ||
| /// </summary> |
Comment on lines
+120
to
+122
| /// Gets or sets the plain-text label rendered as the primary button text (e.g., <c>Label="Open"</c>). | ||
| /// For rich content, use <see cref="ChildContent"/> instead. See also <see cref="Description"/> for secondary text. | ||
| /// </summary> |
| /// <summary> | ||
| /// | ||
| /// </summary> | ||
| /// <summary /> |
Comment on lines
+50
to
+51
| /// Gets or sets the collection of items from which radio buttons are generated. | ||
| /// Use with <see cref="RadioLabel"/> and <see cref="RadioValue"/> to control display text and submitted value. |
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 input control components so the MCP server serves accurate descriptions to AI models.Components
Labelwrong description,IconOnlygrammar,DisabledFocusablemisleading phrasingStartTemplate/EndTemplatevague,AutoCompleteformatcref, grammar errorsCheckStategrammar + missingThreeStatecross-refItemsempty summary,RadioDisabledgrammarPart of
Part of #4777