Migrate PlatformConfiguration API docs from external XML to inline#33629
Merged
jfversluis merged 2 commits intomainfrom Jan 21, 2026
Merged
Migrate PlatformConfiguration API docs from external XML to inline#33629jfversluis merged 2 commits intomainfrom
jfversluis merged 2 commits intomainfrom
Conversation
- Migrate 59 PlatformConfiguration files from external XML doc references to inline XML documentation - Delete 58 XML files across 7 platform-specific doc directories - Update documentation to be concise and follow guidelines Platforms migrated: - AndroidSpecific (10 files) + AppCompat (2 files) - iOSSpecific (20 files) - WindowsSpecific (10 files) - macOSSpecific (4 files) - GTKSpecific (3 files) - TizenSpecific (9 files) Part of API documentation coverage improvement initiative (PR 3).
Contributor
There was a problem hiding this comment.
Pull request overview
This PR migrates API documentation for 59 PlatformConfiguration files from external XML documentation files to inline XML doc comments, improving maintainability by co-locating documentation with code. The changes span 7 platforms (macOS, iOS, Windows, Android, Tizen, GTK, and AndroidSpecific.AppCompat) and delete 58 corresponding XML files.
Changes:
- Replaced external XML
<include>references with inline<summary>,<param>, and<returns>tags across all PlatformConfiguration files - Deleted 58 external XML documentation files from the
docs/directory - Made all documentation concise (1-2 lines per element) following project guidelines
Reviewed changes
Copilot reviewed 90 out of 117 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| macOSSpecific/*.cs (5 files) | Migrated inline docs for TabsStyle enum, TabbedPage, Page, NavigationTransitionStyle enum, and NavigationPage |
| iOSSpecific/*.cs (20 files) | Migrated inline docs for enums (UpdateMode, UIStatusBarAnimation, UISearchBarStyle, TranslucencyMode, StatusBarTextColorMode, GroupHeaderStyle) and platform configs (TimePicker, TabbedPage, SwipeView, Slider, SearchBar, ScrollView, Picker, NavigationPage, ListView, FlyoutPage, Entry, DatePicker, Cell, Application) |
| WindowsSpecific/*.cs (10 files) | Migrated inline docs for WebView, VisualElement, TabbedPage, SearchBar, RefreshView, ListView, Label, InputView, FlyoutPage, and Application |
| AndroidSpecific/*.cs (10 files) | Migrated inline docs for WebView, ViewCell, TabbedPage, SwipeView, ShellItem, ListView, ImageButton, Entry, Button, and Application |
| AndroidSpecific/AppCompat/*.cs (2 files) | Migrated inline docs for NavigationPage and Application |
| TizenSpecific/*.cs (9 files) | Migrated inline docs for Switch, StyleValues, ProgressBar, Page, NavigationPage, Label, Image, Entry, and Application |
| GTKSpecific/*.cs (3 files) | Migrated inline docs for TabbedPage, NavigationPage, and BoxView |
| docs/**/*.xml (58 files deleted) | Removed external XML documentation files that have been migrated inline |
This was referenced Jan 21, 2026
Open
StephaneDelcroix
previously approved these changes
Jan 21, 2026
Resolved conflicts in 5 platform configuration enum files where both branches had migrated the same docs with slightly different wording. Kept more descriptive versions from this branch.
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 PlatformConfiguration classes from external XML files to inline XML doc comments.
What was done:
Platforms migrated:
This is PR 3 of a series to achieve 100% API documentation coverage.
Testing