[MCP] Improve [Parameter] XML doc comments — Group G: Feedback & Display#4828
Open
AClerbois wants to merge 10 commits intomicrosoft:dev-v5from
Open
[MCP] Improve [Parameter] XML doc comments — Group G: Feedback & Display#4828AClerbois 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
This PR updates C# XML doc comments for [Parameter] properties across several Feedback & Display components so the MCP server returns clearer, less ambiguous parameter descriptions to AI tooling.
Changes:
- Adds inline usage examples (e.g.,
<c>Min="0"</c>) and cross-references (<see cref="..."/>) to key parameters in Slider and Progress components. - Clarifies parameter semantics and reduces ambiguity in Skeleton, RatingDisplay, and Calendar/DatePicker/TimePicker components.
- Fixes incorrect/copy-pasted summaries (notably
FluentRatingDisplay).
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Core/Components/Slider/FluentSlider.razor.cs | Improves Min/Max/ImmediateDelay summaries with examples and cross-references. |
| src/Core/Components/Skeleton/FluentSkeleton.razor.cs | Clarifies Shimmer vs Visible, Circular behavior, and Pattern guidance. |
| src/Core/Components/RatingDisplay/FluentRatingDisplay.razor.cs | Replaces incorrect class summary and strengthens parameter summaries with examples. |
| src/Core/Components/Progress/FluentSpinner.razor.cs | Clarifies AppearanceInverted parameter intent and adds an inline usage example. |
| src/Core/Components/Progress/FluentProgressBar.razor.cs | Improves Min/Max/Value/Color/Thickness summaries and adds examples/cross-links. |
| src/Core/Components/DateTime/FluentTimePicker.razor.cs | Documents RenderStyle, clarifies DisabledTimeFunc, and refines StartHour/EndHour summaries. |
| src/Core/Components/DateTime/FluentDatePicker.razor.cs | Fixes Icon vs Appearance summary mismatch and documents RenderStyle. |
| src/Core/Components/DateTime/FluentCalendar.razor.cs | Fixes typos/wording and clarifies SelectMode and SelectDatesHover behavior. |
|
|
||
| /// <summary> | ||
| /// Gets or sets the shape | ||
| /// Gets or sets the icon used for each rating item (e.g., <c>Shape="new MyIcons.Star()"</c>). |
Comment on lines
+55
to
59
| /// Gets or sets the icon displayed in the date picker toggle button (e.g., <c>Icon="new CoreIcons.Regular.Size20.Calendar()"</c>). | ||
| /// Defaults to the calendar icon. | ||
| /// </summary> | ||
| [Parameter] | ||
| public Icon Icon { get; set; } = new CoreIcons.Regular.Size20.Calendar().WithColor("currentColor"); |
| /// <summary> | ||
| /// Gets or sets the predefined skeleton pattern used to define the structure or layout of the component. | ||
| /// You can customize the skeleton's appearance by using <see cref="ChildContent" /> | ||
| /// Gets or sets the predefined skeleton pattern used to define the structure or layout of the component |
| /// <summary> | ||
| /// Gets or sets a value indicating whether the skeleton in a circular mode. | ||
| /// Gets or sets a value indicating whether the skeleton is displayed as a circle. | ||
| /// When <see langword="true"/>, both <see cref="Width"/> and <see cref="Height"/> are set to the same value to form a circle. |
| /// <summary> | ||
| /// Gets ot sets if the calendar items are animated during a period change. | ||
| /// Gets or sets a value indicating whether calendar items are animated during a period change. | ||
| /// By default, the animation is enabled for Months views, but disabled for Days and Years view. |
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 feedback and display components so the MCP server serves accurate descriptions to AI models.Components
Thicknessname/description mismatch, swapped CSS cross-refsShimmerambiguous withVisible, grammar issuesFluentProgressBarMinsaid "minimal" (not a valid description),ImmediateDelaygrammarIconsame description asAppearance, empty summaries on several propsPart of
Part of #4777