API documentation debt - WPF

[carlossanlop]

As part of the 6.0 goals, we want to finish documenting APIs that were shipped without triple slash documentation in previous .NET Core versions.

This work item is part of:

• https://github.com/dotnet/core/issues/5410 Epic: Make sure .NET libraries are continuously improved.
• Developers can access documentation for all .NET Core/.NET 5 APIs runtime#43849 API documentation debt for Libraries, WinForms and WPF

We would like the WPF team to help with this effort by addressing the APIs in the list below, which are missing some or all of their documentation.

Make sure to follow the documentation guidelines defined in the dotnet-api-docs wiki:
https://github.com/dotnet/dotnet-api-docs/wiki

Please add me as a PR reviewer.

Community contributions are welcome.

Update: Here are the APIs introduced in 6.0. Please get their documentation merged before Tuesday 14th, directly in the net6-rc1 branch of the dotnet-api-docs repo.

6.0 APIs

Undoc APIs
M:System.Windows.Automation.ActiveTextPositionChangedEventArgs.#ctor(System.Windows.Automation.Provider.ITextRangeProvider)
T:System.Windows.Automation.ActiveTextPositionChangedEventArgs
P:System.Windows.Automation.ActiveTextPositionChangedEventArgs.TextRange
F:System.Windows.Automation.AutomationElement.ActiveTextPositionChangedEvent
F:System.Windows.Automation.AutomationElement.HeadingLevelProperty
F:System.Windows.Automation.AutomationElement.IsDialogProperty
F:System.Windows.Automation.AutomationElement.NotificationEvent
F:System.Windows.Automation.AutomationElementIdentifiers.ActiveTextPositionChangedEvent
F:System.Windows.Automation.AutomationElementIdentifiers.HeadingLevelProperty
F:System.Windows.Automation.AutomationElementIdentifiers.IsDialogProperty
F:System.Windows.Automation.AutomationElementIdentifiers.NotificationEvent
T:System.Windows.Automation.AutomationHeadingLevel
F:System.Windows.Automation.AutomationHeadingLevel.Level1
F:System.Windows.Automation.AutomationHeadingLevel.Level2
F:System.Windows.Automation.AutomationHeadingLevel.Level3
F:System.Windows.Automation.AutomationHeadingLevel.Level4
F:System.Windows.Automation.AutomationHeadingLevel.Level5
F:System.Windows.Automation.AutomationHeadingLevel.Level6
F:System.Windows.Automation.AutomationHeadingLevel.Level7
F:System.Windows.Automation.AutomationHeadingLevel.Level8
F:System.Windows.Automation.AutomationHeadingLevel.Level9
F:System.Windows.Automation.AutomationHeadingLevel.None
F:System.Windows.Automation.AutomationNotificationKind.ActionAborted
F:System.Windows.Automation.AutomationNotificationKind.ActionCompleted
T:System.Windows.Automation.AutomationNotificationKind
F:System.Windows.Automation.AutomationNotificationKind.ItemAdded
F:System.Windows.Automation.AutomationNotificationKind.ItemRemoved
F:System.Windows.Automation.AutomationNotificationKind.Other
F:System.Windows.Automation.AutomationNotificationProcessing.All
T:System.Windows.Automation.AutomationNotificationProcessing
F:System.Windows.Automation.AutomationNotificationProcessing.CurrentThenMostRecent
F:System.Windows.Automation.AutomationNotificationProcessing.ImportantAll
F:System.Windows.Automation.AutomationNotificationProcessing.ImportantMostRecent
F:System.Windows.Automation.AutomationNotificationProcessing.MostRecent
M:System.Windows.Automation.AutomationProperties.GetHeadingLevel(System.Windows.DependencyObject)
M:System.Windows.Automation.AutomationProperties.GetIsDialog(System.Windows.DependencyObject)
P:System.Windows.Automation.AutomationProperties.HeadingLevel
F:System.Windows.Automation.AutomationProperties.HeadingLevelProperty
P:System.Windows.Automation.AutomationProperties.IsDialog
F:System.Windows.Automation.AutomationProperties.IsDialogProperty
M:System.Windows.Automation.AutomationProperties.SetHeadingLevel(System.Windows.DependencyObject,System.Windows.Automation.AutomationHeadingLevel)
M:System.Windows.Automation.AutomationProperties.SetIsDialog(System.Windows.DependencyObject,System.Boolean)
M:System.Windows.Automation.NotificationEventArgs.#ctor(System.Windows.Automation.AutomationNotificationKind,System.Windows.Automation.AutomationNotificationProcessing,System.String,System.String)
P:System.Windows.Automation.NotificationEventArgs.ActivityId
P:System.Windows.Automation.NotificationEventArgs.DisplayString
T:System.Windows.Automation.NotificationEventArgs
P:System.Windows.Automation.NotificationEventArgs.NotificationKind
P:System.Windows.Automation.NotificationEventArgs.NotificationProcessing
F:System.Windows.Automation.Peers.AutomationEvents.ActiveTextPositionChanged
F:System.Windows.Automation.Peers.AutomationEvents.Notification
M:System.Windows.Automation.Peers.AutomationPeer.GetHeadingLevel
M:System.Windows.Automation.Peers.AutomationPeer.GetHeadingLevelCore
M:System.Windows.Automation.Peers.AutomationPeer.IsDialog
M:System.Windows.Automation.Peers.AutomationPeer.IsDialogCore
M:System.Windows.Automation.Peers.AutomationPeer.RaiseNotificationEvent(System.Windows.Automation.AutomationNotificationKind,System.Windows.Automation.AutomationNotificationProcessing,System.String,System.String)
M:System.Windows.Automation.Peers.ContentElementAutomationPeer.GetHeadingLevelCore
M:System.Windows.Automation.Peers.ContentElementAutomationPeer.IsDialogCore
M:System.Windows.Automation.Peers.ContentTextAutomationPeer.RaiseActiveTextPositionChangedEvent(System.Windows.Documents.TextPointer,System.Windows.Documents.TextPointer)
M:System.Windows.Automation.Peers.ItemAutomationPeer.GetHeadingLevelCore
M:System.Windows.Automation.Peers.ItemAutomationPeer.IsDialogCore
M:System.Windows.Automation.Peers.TextAutomationPeer.RaiseActiveTextPositionChangedEvent(System.Windows.Documents.TextPointer,System.Windows.Documents.TextPointer)
M:System.Windows.Automation.Peers.UIElement3DAutomationPeer.GetHeadingLevelCore
M:System.Windows.Automation.Peers.UIElement3DAutomationPeer.IsDialogCore
M:System.Windows.Automation.Peers.UIElementAutomationPeer.GetHeadingLevelCore
M:System.Windows.Automation.Peers.UIElementAutomationPeer.IsDialogCore
P:System.Windows.Controls.ToolTip.ShowsToolTipOnKeyboardFocus
F:System.Windows.Controls.ToolTip.ShowsToolTipOnKeyboardFocusProperty
M:System.Windows.Controls.ToolTipService.GetShowsToolTipOnKeyboardFocus(System.Windows.DependencyObject)
M:System.Windows.Controls.ToolTipService.SetShowsToolTipOnKeyboardFocus(System.Windows.DependencyObject,System.Nullable{System.Boolean})
P:System.Windows.Controls.ToolTipService.ShowsToolTipOnKeyboardFocus
F:System.Windows.Controls.ToolTipService.ShowsToolTipOnKeyboardFocusProperty

Older APIs:

System.Windows.Diagnostics

DocId	Summary	Parameters	TypeParameters	ReturnValue	Source File Path	Docs URL
E:System.Windows.Diagnostics.BindingDiagnostics.BindingFailed	Missing	NA	NA	NA	https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Windows.Diagnostics/BindingDiagnostics.xml	https://review.docs.microsoft.com/en-us/dotnet/api/System.Windows.Diagnostics.BindingDiagnostics.BindingFailed?branch=master
M:System.Windows.Diagnostics.BindingFailedEventArgs.#ctor	Missing	NA	NA	NA	https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Windows.Diagnostics/BindingFailedEventArgs.xml	https://review.docs.microsoft.com/en-us/dotnet/api/System.Windows.Diagnostics.BindingFailedEventArgs.-ctor?branch=master
P:System.Windows.Diagnostics.BindingFailedEventArgs.Binding	Missing	NA	NA	NA	https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Windows.Diagnostics/BindingFailedEventArgs.xml	https://review.docs.microsoft.com/en-us/dotnet/api/System.Windows.Diagnostics.BindingFailedEventArgs.Binding?branch=master
P:System.Windows.Diagnostics.BindingFailedEventArgs.Code	Missing	NA	NA	NA	https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Windows.Diagnostics/BindingFailedEventArgs.xml	https://review.docs.microsoft.com/en-us/dotnet/api/System.Windows.Diagnostics.BindingFailedEventArgs.Code?branch=master
P:System.Windows.Diagnostics.BindingFailedEventArgs.EventType	Missing	NA	NA	NA	https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Windows.Diagnostics/BindingFailedEventArgs.xml	https://review.docs.microsoft.com/en-us/dotnet/api/System.Windows.Diagnostics.BindingFailedEventArgs.EventType?branch=master
P:System.Windows.Diagnostics.BindingFailedEventArgs.Message	Missing	NA	NA	NA	https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Windows.Diagnostics/BindingFailedEventArgs.xml	https://review.docs.microsoft.com/en-us/dotnet/api/System.Windows.Diagnostics.BindingFailedEventArgs.Message?branch=master
P:System.Windows.Diagnostics.BindingFailedEventArgs.Parameters	Missing	NA	NA	NA	https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Windows.Diagnostics/BindingFailedEventArgs.xml	https://review.docs.microsoft.com/en-us/dotnet/api/System.Windows.Diagnostics.BindingFailedEventArgs.Parameters?branch=master
T:System.Windows.Diagnostics.BindingDiagnostics	Missing	NA	NA	NA	https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Windows.Diagnostics/BindingDiagnostics.xml	https://review.docs.microsoft.com/en-us/dotnet/api/System.Windows.Diagnostics.BindingDiagnostics?branch=master
T:System.Windows.Diagnostics.BindingFailedEventArgs	Missing	NA	NA	NA	https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Windows.Diagnostics/BindingFailedEventArgs.xml	https://review.docs.microsoft.com/en-us/dotnet/api/System.Windows.Diagnostics.BindingFailedEventArgs?branch=master

System.Windows.Markup

DocId	Summary	Parameters	TypeParameters	ReturnValue	Source File Path	Docs URL
M:System.Windows.Markup.XamlReader.Load(System.IO.Stream,System.Boolean)	Missing	Missing	NA	Missing	https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Windows.Markup/XamlReader.xml	https://review.docs.microsoft.com/en-us/dotnet/api/System.Windows.Markup.XamlReader.Load?branch=master
M:System.Windows.Markup.XamlReader.Load(System.IO.Stream,System.Windows.Markup.ParserContext,System.Boolean)	Missing	Missing	NA	Missing	https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Windows.Markup/XamlReader.xml	https://review.docs.microsoft.com/en-us/dotnet/api/System.Windows.Markup.XamlReader.Load?branch=master
M:System.Windows.Markup.XamlReader.Load(System.Xml.XmlReader,System.Boolean)	Missing	Missing	NA	Missing	https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Windows.Markup/XamlReader.xml	https://review.docs.microsoft.com/en-us/dotnet/api/System.Windows.Markup.XamlReader.Load?branch=master
M:System.Windows.Markup.XamlReader.LoadAsync(System.IO.Stream,System.Boolean)	Missing	Missing	NA	Missing	https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Windows.Markup/XamlReader.xml	https://review.docs.microsoft.com/en-us/dotnet/api/System.Windows.Markup.XamlReader.LoadAsync?branch=master
M:System.Windows.Markup.XamlReader.LoadAsync(System.IO.Stream,System.Windows.Markup.ParserContext,System.Boolean)	Missing	Missing	NA	Missing	https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Windows.Markup/XamlReader.xml	https://review.docs.microsoft.com/en-us/dotnet/api/System.Windows.Markup.XamlReader.LoadAsync?branch=master
M:System.Windows.Markup.XamlReader.LoadAsync(System.Xml.XmlReader,System.Boolean)	Missing	Missing	NA	Missing	https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Windows.Markup/XamlReader.xml	https://review.docs.microsoft.com/en-us/dotnet/api/System.Windows.Markup.XamlReader.LoadAsync?branch=master
M:System.Windows.Markup.XamlReader.Parse(System.String,System.Boolean)	Missing	Missing	NA	Missing	https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Windows.Markup/XamlReader.xml	https://review.docs.microsoft.com/en-us/dotnet/api/System.Windows.Markup.XamlReader.Parse?branch=master
M:System.Windows.Markup.XamlReader.Parse(System.String,System.Windows.Markup.ParserContext,System.Boolean)	Missing	Missing	NA	Missing	https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Windows.Markup/XamlReader.xml	https://review.docs.microsoft.com/en-us/dotnet/api/System.Windows.Markup.XamlReader.Parse?branch=master

System.Xaml.Permissions

DocId	Summary	Parameters	TypeParameters	ReturnValue	Source File Path	Docs URL
M:System.Xaml.Permissions.XamlLoadPermission.Equals(System.Object)	Missing	Missing	NA	Missing	https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Xaml.Permissions/XamlLoadPermission.xml	https://review.docs.microsoft.com/en-us/dotnet/api/System.Xaml.Permissions.XamlLoadPermission.Equals?branch=master
M:System.Xaml.Permissions.XamlLoadPermission.GetHashCode	Missing	NA	NA	Missing	https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Xaml.Permissions/XamlLoadPermission.xml	https://review.docs.microsoft.com/en-us/dotnet/api/System.Xaml.Permissions.XamlLoadPermission.GetHashCode?branch=master

cc @RussKie

[GreatGhostsss]

Hi there, if this API needs REST documentation, I'd love to help.

[ghost]

@carlossanlop @GreatGhostsss if the documentation for these APIs are still in progress, I'd like to help.

[carlossanlop]

@GreatGhostsss apologies for missing your message. I do not know if these APIs need REST documentation. @RussKie can you confirm?

@GloGreen if you'd like to contribute, feel free to submit PRs directly to the dotnet/dotnet-api-docs repo. Let me know if you need some guidance. I suggest you look at random merged PRs to see how it's done.

[RussKie]

This is @ryalanms's realm.