Skip to content

Migrate Controls API docs from external XML to inline#33641

Merged
jfversluis merged 1 commit intomainfrom
docs/api-docs-controls-part1-inline
Jan 22, 2026
Merged

Migrate Controls API docs from external XML to inline#33641
jfversluis merged 1 commit intomainfrom
docs/api-docs-controls-part1-inline

Conversation

@jfversluis
Copy link
Member

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 Controls Part 1 (core controls, pages, gestures, images, brushes, and more) from external XML files to inline XML doc comments.

What was done:

  • Migrated ~147 control files from external XML doc references to inline XML documentation
  • Deleted ~165 XML files from docs directories
  • Made documentation concise (1-2 lines per guidelines)

Types migrated:

Category Types
Core BindableProperty, Application, Device, ResourceDictionary
Pages ContentPage, TemplatedPage, NavigationPage, TabbedPage, FlyoutPage
Input InputView, TimePicker, Span
Tables TableView types (TableRoot, TableSection, TableIntent)
Cells Cell, EntryCell, SwitchCell
Images ImageSource types, FontImageSource, StreamImageSource, UriImageSource
Brushes GradientBrush, LinearGradientBrush, RadialGradientBrush, SolidColorBrush
Gestures TapGestureRecognizer, SwipeGestureRecognizer
DragDrop DataPackage, DropGestureRecognizer
SwipeView SwipeItem, SwipeItems, SwipeItemView
WebView WebViewSource, navigation events
Visual VisualStateManager, VisualState, VisualStateGroup
RadioButton RadioButton, RadioButtonGroup
Layout FlexLayout, BindableLayout
Routing Routing, RouteFactory, RoutingEffect
Scroll/List ScrollMode, ScrollToPosition, selection events
Internals Many internal types

This is PR 5 of a series to achieve 100% API documentation coverage.

Testing

  • Build succeeds with 0 warnings, 0 errors

- Migrate ~147 control files from external XML doc references to inline XML documentation
- Delete ~165 XML files from docs directories
- Update documentation to be concise and follow guidelines

Types migrated include:
- Core: BindableProperty, Application, Device, ResourceDictionary
- Pages: ContentPage, TemplatedPage, NavigationPage, TabbedPage, FlyoutPage
- Input: InputView, TimePicker, Span
- Tables: TableView types (TableRoot, TableSection, TableIntent)
- Cells: Cell, EntryCell, SwitchCell
- Images: ImageSource types, FontImageSource, StreamImageSource, UriImageSource
- Brushes: GradientBrush, LinearGradientBrush, RadialGradientBrush, SolidColorBrush
- Gestures: TapGestureRecognizer, SwipeGestureRecognizer
- DragDrop: DataPackage, DropGestureRecognizer
- SwipeView: SwipeItem, SwipeItems, SwipeItemView
- WebView: WebViewSource, navigation events
- Visual: VisualStateManager, VisualState, VisualStateGroup
- RadioButton: RadioButton, RadioButtonGroup
- Layout: FlexLayout, BindableLayout
- Routing: Routing, RouteFactory, RoutingEffect
- Scroll/List: ScrollMode, ScrollToPosition, selection events
- Misc: Many event args, enums, type converters, attributes

Part of API documentation coverage improvement initiative (PR 5).
Copilot AI review requested due to automatic review settings January 21, 2026 10:51
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR migrates API documentation for approximately 147 control files from external XML documentation files to inline XML doc comments, following the established pattern for .NET MAUI documentation. The migration covers core controls, pages, gestures, images, brushes, tables, cells, layouts, routing, visual states, and more.

Changes:

  • Deleted ~165 XML documentation files from the docs/ directories
  • Documentation has been moved inline to the corresponding source code files (not shown in these diffs)
  • Maintains existing documentation content while transitioning to the inline format

Reviewed changes

Copilot reviewed 79 out of 312 changed files in this pull request and generated no comments.

Show a summary per file
File Description
Label.xml Removed external XML docs for Label control (display text element)
ItemVisibilityEventArgs.xml Removed event args documentation for ListView item visibility changes
ItemTappedEventArgs.xml Removed event args documentation for item tap events
InvalidNavigationException.xml Removed exception documentation for navigation errors
InputView.xml Removed base class documentation for keyboard input views
InitializationFlags.xml Removed enum documentation for initialization flags
ImageSourceConverter.xml Removed type converter documentation for image sources
ImageSource.xml Removed abstract base class documentation for image loading
HandlerAttribute.xml Removed attribute documentation for platform-specific renderers
GradientStopCollection.xml Removed collection documentation for gradient stops
GradientStop.xml Removed documentation for gradient color/position definitions
GradientBrush.xml Removed abstract base documentation for gradient brushes
GestureRecognizer.xml Removed base class documentation for gesture recognizers
FontImageSource.xml Removed documentation for font-based image sources
FlyoutPage.xml Removed documentation for master-detail page pattern
FlyoutLayoutBehavior.xml Removed enum documentation for flyout layout modes
FlexLayout.xml Removed documentation for Flexbox-style layout container
ExportFontAttribute.xml Removed attribute documentation for font exports
EntryCell.xml Removed documentation for table cell with text entry
Effect.xml Removed documentation for runtime style/property collections
DropGestureRecognizer.xml Removed gesture recognizer documentation for drop operations
DropCompletedEventArgs.xml Removed event args documentation for completed drops
DoubleCollectionConverter.xml Removed type converter documentation for double collections
DoubleCollection.xml Removed collection documentation for double values
DataPackageView.xml Removed documentation for drag-and-drop data view
DataPackagePropertySetView.xml Removed documentation for data package property dictionary view
DataPackageOperation.xml Removed enum documentation for data package operations
PropertyPropagationExtensions.xml Removed internal extension documentation for property propagation

@jfversluis jfversluis added the area-docs Conceptual docs, API docs, Samples label Jan 21, 2026
@jfversluis jfversluis changed the title Migrate Controls Part 1 API docs from external XML to inline Migrate Controls API docs from external XML to inline Jan 21, 2026
@jfversluis jfversluis merged commit cb5c050 into main Jan 22, 2026
27 of 28 checks passed
@jfversluis jfversluis deleted the docs/api-docs-controls-part1-inline branch January 22, 2026 08:49
@github-actions github-actions bot locked and limited conversation to collaborators Feb 21, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-docs Conceptual docs, API docs, Samples

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants