[MCP] Improve [Parameter] XML doc comments — Group B: Overlays & Notifications#4824
Open
AClerbois wants to merge 10 commits into
Open
[MCP] Improve [Parameter] XML doc comments — Group B: Overlays & Notifications#4824AClerbois wants to merge 10 commits into
AClerbois wants to merge 10 commits into
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 on [Parameter] properties across overlay and notification components so MCP-served metadata is more accurate for consumers and AI tools.
Changes:
- Corrects copied/swapped parameter descriptions in popover and tooltip components.
- Clarifies toast and message bar parameter docs with examples, cross-references, and behavior notes.
- Improves dialog-related parameter docs to better distinguish content areas and lifecycle callbacks.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Core/Components/Tooltip/FluentTooltip.razor.cs | Refines UseTooltipService docs and fixes spacing parameter descriptions. |
| src/Core/Components/Toast/FluentToast.razor.cs | Expands toast parameter docs for type, body/body content, actions, and dismiss behavior. |
| src/Core/Components/Popover/FluentPopover.razor.cs | Fixes the Height summary text. |
| src/Core/Components/MessageBar/FluentMessageBar.razor.cs | Clarifies icon override, title/content usage, dismiss behavior, and timestamp docs. |
| src/Core/Components/Dialog/FluentDialogBody.razor.cs | Adds cross-references to distinguish title, title action, and footer action templates. |
| src/Core/Components/Dialog/FluentDialog.razor.cs | Clarifies ChildContent usage and corrects OnStateChange documentation. |
| /// <summary> | ||
| /// Use ITooltipService to create the tooltip, if this service was injected. | ||
| /// If the <see cref="ChildContent"/> is dynamic, set this to false. Default, true. | ||
| /// Gets or sets a value indicating whether the <see cref="ITooltipService"/> is used to render the tooltip. |
Comment on lines
+52
to
+53
| /// Gets or sets the child content rendered inside the dialog when not using the <see cref="DialogService"/>. | ||
| /// When using the <see cref="DialogService"/>, use <see cref="Instance"/> instead. |
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 overlay and notification components so the MCP server serves accurate descriptions to AI models.Components
Heightcopy-paste said "width"SpacingVertical/SpacingHorizontalhad swapped descriptionsOnStateChangewrong description, ambiguousActionTemplateBody/BodyContentmissing cross-refs,QuickAction1/QuickAction2vagueTitleterminology mismatch,Iconoverride not documentedPart of
Part of #4777