Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WPF/PresentationCore-AutomationPeers : Generate XML files from most recent RC1 WPF source and update docs with DocsPortingTool #7160

Open
wants to merge 31 commits into
base: main
Choose a base branch
from

Conversation

ryalanms
Copy link
Member

WPF/PresentationCore-AutomationPeers : Generate XML files from most recent RC1 WPF source and update docs with DocsPortingTool

The RC1 source for these assemblies has 'triple-slash' comments not in the documentation:

PresentationBuildTasks
PresentationCore-AutomationPeers (AutomationPeers, Ink, and Input)
PresentationCore-Interop (Interop, Markup, Media Animation, and Media Effects)
PresentationCore-Media (Imaging and Media3D)
PresentationCore-MediaOther1
PresentationCore-MediaOther2
PresentationCore-Windows (System.Windows)
ReachFramework
System.Windows.Controls.Ribbon
System.Windows.Presentation
UIAutomationClient
UIAutomationTypes
WindowsBase

There is one documentation update PR per assembly, except PresentationCore, which was spit into 6 areas.

(Hide whitespace changes when reviewing files.)

/cc @dotnet/wpf-developers @carlossanlop

VSC-Service-Account and others added 29 commits August 21, 2021 01:02
 Build.Reason:Manual by Genevieve Warren
 Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=248605&view=results
 source_repo.branch:net6-rc1
 source_repo.url:https://apidrop.visualstudio.com/_git/binaries
* Update InteropServices doc

* Docs for MemoryMarshal and PosixSignalContext.

* Doc update for CollectionsMarshal

* Update docs for Objective-C classes
…net#7103)

* Port triple-slash comments to docs for Microsoft.Extensions.Http

* Apply suggestions from code review

Co-authored-by: Genevieve Warren <[email protected]>

Co-authored-by: Genevieve Warren <[email protected]>
* Add WebSocket and HttpHeadersNonValidated missing APIs

* Update xml/System.Net.Http.Headers/HttpHeadersNonValidated.xml

Co-authored-by: Genevieve Warren <[email protected]>

Co-authored-by: Genevieve Warren <[email protected]>
* Port System.Net triple slash to docs

* Address suggestions by gewarren

Co-authored-by: carlossanlop <[email protected]>
* Port System.Text.Json triple slash to docs

* fix warnings

* Apply suggestions from code review

Co-authored-by: Genevieve Warren <[email protected]>

Co-authored-by: carlossanlop <[email protected]>
Co-authored-by: Genevieve Warren <[email protected]>
* Port System.Diagnostics triple slash to docs

* Apply suggestions from code review

Co-authored-by: Genevieve Warren <[email protected]>

Co-authored-by: carlossanlop <[email protected]>
Co-authored-by: Genevieve Warren <[email protected]>
* Update symlink documentation

* Apply suggestions from code review

Co-authored-by: Genevieve Warren <[email protected]>

Co-authored-by: Genevieve Warren <[email protected]>
* Port System triple slash to docs

* Apply suggestions from code review

Co-authored-by: Genevieve Warren <[email protected]>

* String suggestions

Co-authored-by: carlossanlop <[email protected]>
Co-authored-by: Genevieve Warren <[email protected]>
…e slash to docs (dotnet#7102)

* Port System.Runtime.Versioning.RequiresPreviewFeaturesAttribute triple slash to docs

* suggestion by pgovind

* add link

* Apply suggestions from code review

Co-authored-by: Genevieve Warren <[email protected]>

Co-authored-by: carlossanlop <[email protected]>
Co-authored-by: Genevieve Warren <[email protected]>
* Port System.Reflection triple slash to docs

* Apply suggestions from code review

Co-authored-by: Genevieve Warren <[email protected]>
Co-authored-by: Buyaa Namnan <[email protected]>

Co-authored-by: carlossanlop <[email protected]>
Co-authored-by: Genevieve Warren <[email protected]>
Co-authored-by: Buyaa Namnan <[email protected]>
* Port System.Security.Cryptography.Xml triple slash to docs

* Apply suggestions from code review

Co-authored-by: Genevieve Warren <[email protected]>

* Update xml/System.Security.Cryptography.Xml/CryptoSignedXmlRecursionException.xml

Co-authored-by: Genevieve Warren <[email protected]>

* Apply suggestions from code review

Co-authored-by: Genevieve Warren <[email protected]>

Co-authored-by: carlossanlop <[email protected]>
Co-authored-by: Genevieve Warren <[email protected]>
* Add docs for missing members in System.CodeDom

* Add missing return statement

* Apply suggestions from code review

Co-authored-by: Carlos Sanchez <[email protected]>

Co-authored-by: Carlos Sanchez <[email protected]>
* Port System.Security.Cryptography triple slash to docs

* Fix -or- spacing

* Apply suggestions from code review

Co-authored-by: Genevieve Warren <[email protected]>

Co-authored-by: carlossanlop <[email protected]>
Co-authored-by: Genevieve Warren <[email protected]>
* Ported docs from dotnet/runtime#57855

* Update xml/System.Net.Http/HeaderEncodingSelector`1.xml

Co-authored-by: Carlos Sanchez <[email protected]>
* Correct missing devdoc.

* Apply suggestions from code review

Co-authored-by: Carlos Sanchez <[email protected]>
* Port IntPtr and MemoryExtensions triple slash to docs

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Genevieve Warren <[email protected]>

Co-authored-by: carlossanlop <[email protected]>
Co-authored-by: Genevieve Warren <[email protected]>
Co-authored-by: Genevieve Warren <[email protected]>
@dotnet-issue-labeler dotnet-issue-labeler bot added the area-WPF Issues or PRs that relate to WPF or XAML. label Sep 13, 2021
@opbld33
Copy link

opbld33 commented Sep 13, 2021

Docs Build status updates of commit 901fc58:

⚠️ Validation status: warnings

File Status Preview URL Details
xml/System.Windows.Automation/AutomationProperties.xml ⚠️Warning View Details
xml/System.Windows.Input/InputType.xml 💡Suggestion View Details
xml/System.Windows.Automation.Peers/AutomationPeer.xml ✅Succeeded View
xml/System.Windows.Automation.Peers/ContentElementAutomationPeer.xml ✅Succeeded View
xml/System.Windows.Automation.Peers/UIElement3DAutomationPeer.xml ✅Succeeded View
xml/System.Windows.Automation.Peers/UIElementAutomationPeer.xml ✅Succeeded View
xml/System.Windows.Automation/AutomationHeadingLevel.xml ✅Succeeded View
xml/System.Windows.Documents/DocumentPaginator.xml ✅Succeeded View
xml/System.Windows.Documents/DynamicDocumentPaginator.xml ✅Succeeded View
xml/System.Windows.Ink/DrawingAttributes.xml ✅Succeeded View
xml/System.Windows.Ink/DrawingAttributesReplacedEventArgs.xml ✅Succeeded View
xml/System.Windows.Ink/Stroke.xml ✅Succeeded View
xml/System.Windows.Ink/StrokeCollection.xml ✅Succeeded View
xml/System.Windows.Ink/StylusPointsReplacedEventArgs.xml ✅Succeeded View
xml/System.Windows.Input.StylusPlugIns/StylusPlugInCollection.xml ✅Succeeded View
xml/System.Windows.Input/CanExecuteRoutedEventArgs.xml ✅Succeeded View
xml/System.Windows.Input/Cursor.xml ✅Succeeded View
xml/System.Windows.Input/ExecutedRoutedEventArgs.xml ✅Succeeded View
xml/System.Windows.Input/IManipulator.xml ✅Succeeded View
xml/System.Windows.Input/InputGesture.xml ✅Succeeded View
xml/System.Windows.Input/ManipulationBoundaryFeedbackEventArgs.xml ✅Succeeded View
xml/System.Windows.Input/ManipulationCompletedEventArgs.xml ✅Succeeded View
xml/System.Windows.Input/ManipulationDeltaEventArgs.xml ✅Succeeded View
xml/System.Windows.Input/ManipulationInertiaStartingEventArgs.xml ✅Succeeded View
xml/System.Windows.Input/ManipulationStartedEventArgs.xml ✅Succeeded View
xml/System.Windows.Input/ManipulationStartingEventArgs.xml ✅Succeeded View
xml/System.Windows.Input/MouseDevice.xml ✅Succeeded View
xml/System.Windows.Input/StylusButton.xml ✅Succeeded View
xml/System.Windows.Input/StylusPointProperty.xml ✅Succeeded View
xml/System.Windows.Input/TabletDeviceCollection.xml ✅Succeeded View
xml/System.Windows.Input/TouchDevice.xml ✅Succeeded View
xml/System.Windows.Interop/HwndSource.xml ✅Succeeded View

xml/System.Windows.Automation/AutomationProperties.xml

  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: '!:https://msdn.microsoft.com/en-us/library/windows/desktop/ee684017(v=vs.85).aspx'.
  • Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: '!:https://msdn.microsoft.com/en-us/library/windows/desktop/ee684017(v=vs.85).aspx'.

xml/System.Windows.Input/InputType.xml

  • Line 0, Column 0: [Suggestion-disallowed-html-tag] HTML tag 'para' isn't allowed. Disallowed HTML poses a security risk and must be replaced with approved Docs Markdown syntax.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Copy link
Member

@carlossanlop carlossanlop left a comment

Choose a reason for hiding this comment

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

Suggestions to fix warnings

@opbld32
Copy link

opbld32 commented Sep 13, 2021

Docs Build status updates of commit 27394bb:

✅ Validation status: passed

File Status Preview URL Details
xml/System.Windows.Automation.Peers/AutomationPeer.xml ✅Succeeded View
xml/System.Windows.Automation.Peers/ContentElementAutomationPeer.xml ✅Succeeded View
xml/System.Windows.Automation.Peers/UIElement3DAutomationPeer.xml ✅Succeeded View
xml/System.Windows.Automation.Peers/UIElementAutomationPeer.xml ✅Succeeded View
xml/System.Windows.Automation/AutomationHeadingLevel.xml ✅Succeeded View
xml/System.Windows.Automation/AutomationProperties.xml ✅Succeeded View
xml/System.Windows.Documents/DocumentPaginator.xml ✅Succeeded View
xml/System.Windows.Documents/DynamicDocumentPaginator.xml ✅Succeeded View
xml/System.Windows.Ink/DrawingAttributes.xml ✅Succeeded View
xml/System.Windows.Ink/DrawingAttributesReplacedEventArgs.xml ✅Succeeded View
xml/System.Windows.Ink/Stroke.xml ✅Succeeded View
xml/System.Windows.Ink/StrokeCollection.xml ✅Succeeded View
xml/System.Windows.Ink/StylusPointsReplacedEventArgs.xml ✅Succeeded View
xml/System.Windows.Input.StylusPlugIns/StylusPlugInCollection.xml ✅Succeeded View
xml/System.Windows.Input/CanExecuteRoutedEventArgs.xml ✅Succeeded View
xml/System.Windows.Input/Cursor.xml ✅Succeeded View
xml/System.Windows.Input/ExecutedRoutedEventArgs.xml ✅Succeeded View
xml/System.Windows.Input/IManipulator.xml ✅Succeeded View
xml/System.Windows.Input/InputGesture.xml ✅Succeeded View
xml/System.Windows.Input/InputType.xml ✅Succeeded View
xml/System.Windows.Input/ManipulationBoundaryFeedbackEventArgs.xml ✅Succeeded View
xml/System.Windows.Input/ManipulationCompletedEventArgs.xml ✅Succeeded View
xml/System.Windows.Input/ManipulationDeltaEventArgs.xml ✅Succeeded View
xml/System.Windows.Input/ManipulationInertiaStartingEventArgs.xml ✅Succeeded View
xml/System.Windows.Input/ManipulationStartedEventArgs.xml ✅Succeeded View
xml/System.Windows.Input/ManipulationStartingEventArgs.xml ✅Succeeded View
xml/System.Windows.Input/MouseDevice.xml ✅Succeeded View
xml/System.Windows.Input/StylusButton.xml ✅Succeeded View
xml/System.Windows.Input/StylusPointProperty.xml ✅Succeeded View
xml/System.Windows.Input/TabletDeviceCollection.xml ✅Succeeded View
xml/System.Windows.Input/TouchDevice.xml ✅Succeeded View
xml/System.Windows.Interop/HwndSource.xml ✅Succeeded View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@gewarren gewarren deleted the branch dotnet:main September 14, 2021 20:05
@gewarren gewarren closed this Sep 14, 2021
@gewarren gewarren reopened this Sep 29, 2021
@gewarren gewarren changed the base branch from net6-rc1 to main September 29, 2021 17:29
@opbld30
Copy link

opbld30 commented Sep 29, 2021

Docs Build status updates of commit 27394bb:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
❌Error Details

  • [Error-PullRequestMergeConflict] Cannot sync git repo to specified state. Please make sure the pull request is mergeable.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@opbld34
Copy link

opbld34 commented Sep 30, 2021

Docs Build status updates of commit ffa9851:

✅ Validation status: passed

File Status Preview URL Details
xml/Microsoft.Build.Tasks/CreateProperty.xml ✅Succeeded View
xml/System.Windows.Automation.Peers/AutomationPeer.xml ✅Succeeded View
xml/System.Windows.Automation.Peers/ContentElementAutomationPeer.xml ✅Succeeded View
xml/System.Windows.Automation.Peers/UIElement3DAutomationPeer.xml ✅Succeeded View
xml/System.Windows.Automation.Peers/UIElementAutomationPeer.xml ✅Succeeded View
xml/System.Windows.Automation/AutomationHeadingLevel.xml ✅Succeeded View
xml/System.Windows.Automation/AutomationProperties.xml ✅Succeeded View
xml/System.Windows.Documents/DocumentPaginator.xml ✅Succeeded View
xml/System.Windows.Documents/DynamicDocumentPaginator.xml ✅Succeeded View
xml/System.Windows.Ink/DrawingAttributes.xml ✅Succeeded View
xml/System.Windows.Ink/DrawingAttributesReplacedEventArgs.xml ✅Succeeded View
xml/System.Windows.Ink/Stroke.xml ✅Succeeded View
xml/System.Windows.Ink/StrokeCollection.xml ✅Succeeded View
xml/System.Windows.Ink/StylusPointsReplacedEventArgs.xml ✅Succeeded View
xml/System.Windows.Input.StylusPlugIns/StylusPlugInCollection.xml ✅Succeeded View
xml/System.Windows.Input/CanExecuteRoutedEventArgs.xml ✅Succeeded View
xml/System.Windows.Input/Cursor.xml ✅Succeeded View
xml/System.Windows.Input/ExecutedRoutedEventArgs.xml ✅Succeeded View
xml/System.Windows.Input/IManipulator.xml ✅Succeeded View
xml/System.Windows.Input/InputGesture.xml ✅Succeeded View
xml/System.Windows.Input/InputType.xml ✅Succeeded View
xml/System.Windows.Input/ManipulationBoundaryFeedbackEventArgs.xml ✅Succeeded View
xml/System.Windows.Input/ManipulationCompletedEventArgs.xml ✅Succeeded View
xml/System.Windows.Input/ManipulationDeltaEventArgs.xml ✅Succeeded View
xml/System.Windows.Input/ManipulationInertiaStartingEventArgs.xml ✅Succeeded View
xml/System.Windows.Input/ManipulationStartedEventArgs.xml ✅Succeeded View
xml/System.Windows.Input/ManipulationStartingEventArgs.xml ✅Succeeded View
xml/System.Windows.Input/MouseDevice.xml ✅Succeeded View
xml/System.Windows.Input/StylusButton.xml ✅Succeeded View
xml/System.Windows.Input/StylusPointProperty.xml ✅Succeeded View
xml/System.Windows.Input/TabletDeviceCollection.xml ✅Succeeded View
xml/System.Windows.Input/TouchDevice.xml ✅Succeeded View
xml/System.Windows.Interop/HwndSource.xml ✅Succeeded View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

</ReturnValue>
<Parameters />
<Docs>
<summary>Attempt to get the value for the HeadingLevel property.</summary>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<summary>Attempt to get the value for the HeadingLevel property.</summary>
<summary>Attempts to get the value for the HeadingLevel property.</summary>

</ReturnValue>
<Parameters />
<Docs>
<summary>Override this method to provide UIAutomation with the heading level of this element.</summary>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<summary>Override this method to provide UIAutomation with the heading level of this element.</summary>
<summary>Provides UIAutomation with the heading level of this element.</summary>

</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</Ret
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
</Ret
<summary>Attempts to get the value for the IsDialog property.</summary>

</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</Ret
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
</Ret
<summary>Raises the automation "notification" event. This method is called by an implementation of the peer.</summary>

</ReturnValue>
<Parameters />
<Docs>
<summary>Provides a value for UIAutomation's HeadingLevel property Reads <see cref="F:System.Windows.Automation.AutomationProperties.HeadingLevelProperty" /> and returns the value</summary>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<summary>Provides a value for UIAutomation's HeadingLevel property Reads <see cref="F:System.Windows.Automation.AutomationProperties.HeadingLevelProperty" /> and returns the value</summary>
<summary>Gets the value for UIAutomation's HeadingLevel property. Reads <see cref="F:System.Windows.Automation.AutomationProperties.HeadingLevelProperty" /> and returns the value.</summary>


## Remarks

Protected - used by the StylusPointPropertyInfo ctor
Copy link
Contributor

Choose a reason for hiding this comment

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

Not relevant.


Callers must have UIPermission(UIPermissionWindow.AllWindows) to call this API.

Subclasses should use SetActiveSource to set this property.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Subclasses should use SetActiveSource to set this property.
Subclasses should use `SetActiveSource` to set this property.


## Remarks

This value affects hit-testing to determine DirectlyOver.
Copy link
Contributor

Choose a reason for hiding this comment

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

Relevant?

## Remarks

Setting KeyboardInputSite is not available in Internet Zone.
We explicitly don't make this property overridable as we want to keep the
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this part relevant?

## Remarks

This API requires unrestricted UI Window permission.
We explicitly don't make this method overridable as we want to keep the
Copy link
Contributor

Choose a reason for hiding this comment

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

Relevant?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-WPF Issues or PRs that relate to WPF or XAML.
Projects
None yet
Development

Successfully merging this pull request may close these issues.