Migrate Shell namespace API docs from external XML to inline#33628
Merged
jfversluis merged 1 commit intomainfrom Jan 21, 2026
Merged
Migrate Shell namespace API docs from external XML to inline#33628jfversluis merged 1 commit intomainfrom
jfversluis merged 1 commit intomainfrom
Conversation
- Migrate 19 Shell-related classes from external XML doc references to inline XML documentation - Delete 22 Shell-related XML files from src/Controls/docs/Microsoft.Maui.Controls/ - Update documentation to be concise and follow guidelines - Add 'This is a bindable property.' where appropriate Classes migrated: - Shell, BaseShellItem, ShellItem, ShellSection, ShellContent, ShellGroupItem - ShellAppearance, SearchHandler, BackButtonBehavior - ShellNavigationState, ShellNavigatingEventArgs, ShellNavigatedEventArgs, ShellNavigatingDeferral - ShellNavigationSource, FlyoutDisplayOptions, FlyoutHeaderBehavior, PresentationMode - MenuItemCollection, QueryPropertyAttribute - FlyoutItem, TabBar, Tab (aliases in ShellItem.cs and ShellSection.cs) Part of API documentation coverage improvement initiative (PR 2).
Contributor
There was a problem hiding this comment.
Pull request overview
This PR migrates API documentation for 19 Shell-related classes from external XML files to inline XML doc comments. The migration covers core Shell navigation components including Shell, ShellItem, ShellSection, ShellContent, navigation event args, enums, and supporting classes. The documentation follows concise guidelines with 1-2 line summaries and adds "This is a bindable property." notation where appropriate.
Changes:
- Migrated inline documentation for 19 Shell namespace classes replacing external XML include directives
- Deleted 22 corresponding external XML documentation files
- Applied concise documentation style with proper
<see cref>references and bindable property annotations
Reviewed changes
Copilot reviewed 40 out of 41 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| ShellSection.cs | Added inline docs for Tab alias and ShellSection with constructor, properties (CurrentItem, Items, Stack) |
| ShellNavigationState.cs | Added inline docs for navigation state class with Location property and constructors |
| ShellNavigationSource.cs | Added inline enum docs for navigation source types (Push, Pop, etc.) |
| ShellNavigatingEventArgs.cs | Added inline docs for Navigating event args with navigation state properties and cancellation |
| ShellNavigatingDeferral.cs | Added inline docs for deferral class to support async navigation |
| ShellNavigatedEventArgs.cs | Added inline docs for Navigated event args with Previous, Current, Source properties |
| ShellItem.cs | Added inline docs for FlyoutItem, TabBar aliases and ShellItem with collections and properties |
| ShellGroupItem.cs | Added inline docs for base grouping class with FlyoutDisplayOptions |
| ShellContent.cs | Added inline docs for content class with MenuItems, Content, ContentTemplate properties |
| ShellAppearance.cs | Added inline docs for appearance class with color/brush properties and helper methods |
| Shell.cs | Added inline docs for main Shell class with Current, navigation methods, Items collection |
| SearchHandler.cs | Added inline docs for search functionality with focus, keyboard, formatting properties |
| QueryPropertyAttribute.cs | Added inline docs for query parameter mapping attribute |
| PresentationMode.cs | Added inline enum docs for page presentation modes |
| MenuItemCollection.cs | Added inline docs for MenuItem collection with standard collection methods |
| FlyoutHeaderBehavior.cs | Added inline enum docs for flyout header scroll behavior |
| FlyoutDisplayOptions.cs | Added inline enum docs for flyout display options |
| BackButtonBehavior.cs | Added inline docs for back button customization with command, icon, text properties |
| *.xml (deleted) | Removed 22 external XML documentation files that were migrated inline |
3 tasks
StephaneDelcroix
approved these changes
Jan 21, 2026
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Note
Are you waiting for the changes in this PR to be merged?
It would be very helpful if you could test the resulting artifacts from this PR and let us know in a comment if this change resolves your issue. Thank you!
Description
This PR migrates API documentation for the Shell namespace from external XML files to inline XML doc comments.
What was done:
Classes migrated:
This is PR 2 of a series to achieve 100% API documentation coverage.
Testing