Skip to content

Migrate Core types API docs from external XML to inline#33631

Merged
jfversluis merged 1 commit intomainfrom
docs/api-docs-coretypes-inline
Jan 21, 2026
Merged

Migrate Core types API docs from external XML to inline#33631
jfversluis merged 1 commit intomainfrom
docs/api-docs-coretypes-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 Core types (Binding, DataTemplate, Style, Triggers, Commands) from external XML files to inline XML doc comments.

What was done:

  • Migrated ~37 core type files from external XML doc references to inline XML documentation
  • Deleted 31 XML files from docs directories
  • Made documentation concise (1-2 lines per guidelines)

Types migrated:

Category Types
Binding Binding, BindingMode, MultiBinding, RelativeBindingSource, TemplateBinding, TypedBindingBase
Data Templates DataTemplate, DataTemplateSelector, DataTemplateExtensions
Styles Style, Setter, SettersExtensions, StyleSheet
Triggers Trigger, TriggerBase, TriggerAction, DataTrigger, EventTrigger
State Triggers StateTriggerBase, StateTrigger, AdaptiveTrigger, CompareStateTrigger, DeviceStateTrigger, OrientationStateTrigger
Conditions Condition, BindingCondition, PropertyCondition
Commands Command, Command
Diagnostics BindingDiagnostics, BindingErrorEventArgs

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

Testing

  • Build succeeds with 0 warnings, 0 errors

- Migrate ~37 core type files from external XML doc references to inline XML documentation
- Delete 31 XML files from docs directories
- Update documentation to be concise and follow guidelines

Types migrated:
- Binding: Binding, BindingMode, MultiBinding, RelativeBindingSource, TemplateBinding, TypedBindingBase
- Data templates: DataTemplate, DataTemplateSelector, DataTemplateExtensions
- Styles: Style, Setter, SettersExtensions, StyleSheet
- Triggers: Trigger, TriggerBase, TriggerAction, DataTrigger, EventTrigger
- State triggers: StateTriggerBase, StateTrigger, AdaptiveTrigger, CompareStateTrigger, DeviceStateTrigger, OrientationStateTrigger
- Conditions: Condition, BindingCondition, PropertyCondition
- Commands: Command, Command<T>
- Diagnostics: BindingDiagnostics, BindingErrorEventArgs
- Internals: InvalidationTrigger

Part of API documentation coverage improvement initiative (PR 4).
Copilot AI review requested due to automatic review settings January 20, 2026 18:45
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 pull request migrates API documentation for Core types (Binding, DataTemplate, Style, Triggers, Commands) from external XML files to inline XML doc comments. The migration covers approximately 37 core type files across categories including Binding, Data Templates, Styles, Triggers, State Triggers, Conditions, Commands, and Diagnostics.

Changes:

  • Migrated ~37 core type files from external XML doc references to inline XML documentation
  • Deleted 31 XML files from docs directories
  • Made documentation concise (1-2 lines per guidelines)

Reviewed changes

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

Show a summary per file
File Description
BindingErrorEventArgs.cs Added inline docs for binding diagnostics event arguments
BindingDiagnostics.cs Added inline docs for binding diagnostics class
TypedBinding.cs Added inline docs for type-safe binding base class
TemplateBinding.cs Added inline docs for obsolete template binding
StyleSheet.cs Added inline docs for CSS-like stylesheet
Style.cs Added inline docs for style grouping property setters
StateTriggerBase.cs Added inline docs for state trigger base class
StateTrigger.cs Added inline docs for basic state trigger
SettersExtensions.cs Added inline docs for setter collection extensions
Setter.cs Added inline docs for property setter
RelativeBindingSourceMode.cs Added inline docs for binding source mode enum
RelativeBindingSource.cs Added inline docs for relative binding source
PlatformConfiguration files Added inline docs for platform-specific enums
OrientationStateTrigger.cs Added inline docs for orientation state trigger
MultiBinding.cs Added inline docs for multi-binding
InvalidationTrigger.cs Added inline docs for internal invalidation trigger
TriggerBase.cs Added inline docs for trigger base class
TriggerAction.cs Added inline docs for trigger action
Trigger.cs Added inline docs for property trigger
PropertyCondition.cs Added inline docs for property condition
EventTrigger.cs Added inline docs for event trigger
DataTrigger.cs Added inline docs for data trigger
Condition.cs Added inline docs for condition base class
BindingCondition.cs Added inline docs for binding condition
DeviceStateTrigger.cs Added inline docs for device state trigger
DataTemplateSelector.cs Added inline docs for data template selector
DataTemplateExtensions.cs Added inline docs for data template extensions
DataTemplate.cs Added inline docs for data template
CompareStateTrigger.cs Added inline docs for compare state trigger
Command.cs Added inline docs for command implementations
BindingMode.cs Added inline docs for binding mode enum
Binding.cs Added inline docs for binding class
AdaptiveTrigger.cs Added inline docs for adaptive trigger
Multiple XML files Deleted external XML documentation files

@jfversluis jfversluis added the area-docs Conceptual docs, API docs, Samples label Jan 20, 2026
@jfversluis jfversluis added this to the .NET 10.0 SR4 milestone Jan 20, 2026
@jfversluis jfversluis merged commit c10c9a4 into main Jan 21, 2026
33 of 34 checks passed
@jfversluis jfversluis deleted the docs/api-docs-coretypes-inline branch January 21, 2026 09:19
@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