[MCP] Improve [Parameter] XML doc comments — Group D: Layout Containers#4823
Open
AClerbois wants to merge 8 commits into
Open
[MCP] Improve [Parameter] XML doc comments — Group D: Layout Containers#4823AClerbois wants to merge 8 commits into
AClerbois wants to merge 8 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.
Improves XML doc comments on [Parameter] properties across several layout container components so the MCP server surfaces clearer, more accurate descriptions to AI consumers.
Changes:
- Refines wizard step docs (deferred loading, label/summary descriptions, and per-step numbering docs).
- Clarifies tabs selection parameters (
ActiveTabId/ActiveTab) and adds cross-references + binding hints. - Fixes/rewrites accordion and splitter pane parameter docs to correct malformed or misleading descriptions.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Core/Components/Wizard/FluentWizardStep.razor.cs | Updates step parameter docs for deferred loading and indicator text (Label/Summary). |
| src/Core/Components/Wizard/FluentWizard.razor.cs | Clarifies Border and DisplayStepNumber parameter documentation. |
| src/Core/Components/Tabs/FluentTabs.razor.cs | Improves Appearance, ActiveTabId, and ActiveTab docs with examples and cross-refs. |
| src/Core/Components/Splitter/FluentMultiSplitterPane.razor.cs | Rewrites collapsed/collapsible/resizable and sizing constraint docs. |
| src/Core/Components/Accordion/FluentAccordionItem.razor.cs | Fixes owning type reference and malformed XML; improves Header and Block docs. |
| src/Core/Components/Accordion/FluentAccordion.razor.cs | Aligns Block parameter docs with intended behavior. |
|
|
||
| /// <summary> | ||
| /// Gets or sets the owning FluentTreeView. | ||
| /// Gets or sets the parent <see cref="FluentAccordion"/> that owns this item. |
|
|
||
| /// <summary> | ||
| /// Gets or sets the width of the focus state | ||
| /// Gets or sets whether this accordion item expands to fill the full available width (block-level display). |
|
|
||
| /// <summary> | ||
| /// Gets or sets the width of the focus state | ||
| /// Gets or sets whether accordion items expand to fill the full available width (block-level display). |
Comment on lines
+57
to
66
| /// Gets or sets the maximum size of the pane as a CSS value (e.g., <c>Max="80%"</c>). | ||
| /// </summary> | ||
| [Parameter] | ||
| public string Max { get; set; } = string.Empty; | ||
|
|
||
| /// <summary> | ||
| /// Determines the minimum collapsed. | ||
| /// Gets or sets the minimum size of the pane as a CSS value (e.g., <c>Min="100px"</c>). | ||
| /// </summary> | ||
| [Parameter] | ||
| public string Min { get; set; } = string.Empty; |
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 layout container components so the MCP server serves accurate descriptions to AI models.Components
ActiveTabId/ActiveTabdouble "the" + missing cross-refs between the twoLabel/Summarymissing usage examplesOwnerwrong type name,Headermalformed XMLCollapsed/Collapsible/Resizablebroken grammar,Min/Maxnonsensical descriptionsPart of
Part of #4777