WPF/PresentationCore-Windows : Generate XML files from most recent RC1 WPF source and update docs with DocsPortingTool #7165
Conversation
This file contains 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
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]>
Co-authored-by: Carlos Sanchez <[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]>
…y triple slash to docs (dotnet#7097) Co-authored-by: carlossanlop <[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]>
…cs (dotnet#7095) Co-authored-by: carlossanlop <[email protected]>
* Ported docs from dotnet/runtime#57855 * Update xml/System.Net.Http/HeaderEncodingSelector`1.xml Co-authored-by: Carlos Sanchez <[email protected]>
…uestMessage.Options
* 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]>
missing doc for HttpRequestOptions
dotnet-issue-labeler
bot
added
the
area-WPF
|
Docs Build status updates of commit 9399dd8: ✅ Validation status: passedxml/System.Windows/EventManager.xml
xml/System.Windows/EventRoute.xml
xml/System.Windows/RoutedEventArgs.xml
xml/System.Windows/RoutedEventHandlerInfo.xml
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:
|
Comment on lines
+128
to
+134
| If a node in the tree has different visual and logical, | ||
| FrameworkElement will store the node on this stack of | ||
| branches. If the route ever returns to the same logical | ||
| tree, the event source will be restored. | ||
| <para /> | ||
| NOTE: This method needs to be public because it is used | ||
| by FrameworkElement. |
There was a problem hiding this comment.
Is this information relevant to the final user?
Comment on lines
+173
to
+179
| If a node in the tree has different visual and logical, | ||
| FrameworkElement will store the node on this stack of | ||
| branches. If the route ever returns to the same logical | ||
| tree, the event source will be restored. | ||
| <para /> | ||
| NOTE: This method needs to be public because it is used | ||
| by FrameworkElement. |
Comment on lines
+267
to
+273
| If a node in the tree has different visual and logical, | ||
| FrameworkElement will store the node on this stack of | ||
| branches. If the route ever returns to the same logical | ||
| tree, the event source will be restored. | ||
| <para /> | ||
| NOTE: This method needs to be public because it is used | ||
| by FrameworkElement. |
| </Parameters> | ||
| <Docs> | ||
| <param name="source">To be added.</param> | ||
| <summary>Implementation of Freezable.CloneCore()</summary> |
There was a problem hiding this comment.
Not helpful. Can you please describe what this method does? Also, it's missing a description for the source parameter.
There was a problem hiding this comment.
Could also use <inheritdoc /> here.
| </Parameters> | ||
| <Docs> | ||
| <param name="source">To be added.</param> | ||
| <summary>Implementation of Freezable.CloneCurrentValueCore()</summary> |
There was a problem hiding this comment.
Same request for the rest of the methods: They need a better description, and their parameters documented.
gewarren
reviewed
Sep 13, 2021
| </Parameters> | ||
| <Docs> | ||
| <param name="source">To be added.</param> | ||
| <summary>Implementation of Freezable.CloneCore()</summary> |
There was a problem hiding this comment.
Could also use <inheritdoc /> here.
Co-authored-by: Carlos Sanchez <[email protected]> Co-authored-by: Genevieve Warren <[email protected]>
|
Docs Build status updates of commit 0464de9: ✅ Validation status: passedxml/System.Windows/EventRoute.xml
xml/System.Windows/RoutedEventArgs.xml
xml/System.Windows/RoutedEventHandlerInfo.xml
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:
|
|
Docs Build status updates of commit 0464de9: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
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:
|
|
Docs Build status updates of commit 40927aa: ✅ Validation status: passedxml/System.Windows/EventRoute.xml
xml/System.Windows/RoutedEventArgs.xml
xml/System.Windows/RoutedEventHandlerInfo.xml
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:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
WPF/PresentationCore-Windows : 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