WPF/PresentationCore-Windows : Generate XML files from most recent GA WPF source and update docs with DocsPortingTool #7218
Conversation
This file contains hidden or 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
|
I couldn't figure out the best area label to add to this PR. If you have write-permissions please help me learn by adding exactly one area label. |
| <Parameter Name="source" Type="System.Windows.Freezable" /> | ||
| </Parameters> | ||
| <Docs> | ||
| <param name="source">To be added.</param> |
Contributor
There was a problem hiding this comment.
Missing docs for this param. Can you please add a description? Same request applies for the rest of the APIs in this file.
Contributor
carlossanlop
left a comment
carlossanlop
left a comment
There was a problem hiding this comment.
@ryalanms I left some comments and suggestions for you to consider. Many summaries need a better description.
| </Parameters> | ||
| <Docs> | ||
| <param name="source">To be added.</param> | ||
| <summary>Implementation of Freezable.CloneCore()</summary> |
Contributor
There was a problem hiding this comment.
The description is not helpful for the user. Can you please describe what the API does? Same request applies for the rest of the APIs in this file.
Comment on lines
+149
to
+150
| <exception cref="T:System.NotSupportedException">A NotSupportedException is thrown if the example object is <see langword="null" /> or is not a valid type | ||
| which can be converted to a PathFigureCollection.</exception> |
Contributor
There was a problem hiding this comment.
Suggested change
| <exception cref="T:System.NotSupportedException">A NotSupportedException is thrown if the example object is <see langword="null" /> or is not a valid type | |
| which can be converted to a PathFigureCollection.</exception> | |
| <exception cref="T:System.NotSupportedException"><paramref name="value"/> is <see langword="null" /> or is not a valid type which can be converted to a <see cref="T:System.Windows.Media.PathFigureCollection" />.</exception> |
Comment on lines
+185
to
+186
| <exception cref="T:System.NotSupportedException">A NotSupportedException is thrown if "value" is <see langword="null" /> or not an instance of PathFigureCollection, | ||
| or if the destinationType isn't one of the valid destination types.</exception> |
Contributor
There was a problem hiding this comment.
Suggested change
| <exception cref="T:System.NotSupportedException">A NotSupportedException is thrown if "value" is <see langword="null" /> or not an instance of PathFigureCollection, | |
| or if the destinationType isn't one of the valid destination types.</exception> | |
| <exception cref="T:System.NotSupportedException"><paramref name="value"/> is <see langword="null" /> or not an instance of <see cref="T:System.Windows.Media.PathFigureCollection" />. | |
| -or- | |
| <paramref name="destinationType"/> is not one of the valid destination types.</exception> |
Comment on lines
+326
to
+327
| <summary>Implementation of <see cref="M:System.Windows.Freezable.CreateInstanceCore">Freezable.CreateInstanceCore</see>.</summary> | ||
| <returns>The new Freezable.</returns> |
Contributor
There was a problem hiding this comment.
Can you please improve these descriptions? Same request applies for the other API modified in this file.
| </Parameters> | ||
| <Docs> | ||
| <param name="source">To be added.</param> | ||
| <summary>Implementation of Freezable.CloneCore()</summary> |
Contributor
There was a problem hiding this comment.
Same. Can you please improve this and the rest of the summaries of the modified APIs? Also add the missing param description for all of them.
Comment on lines
+149
to
+150
| <exception cref="T:System.NotSupportedException">A NotSupportedException is thrown if the example object is <see langword="null" /> or is not a valid type | ||
| which can be converted to a VectorCollection.</exception> |
Contributor
There was a problem hiding this comment.
Suggested change
| <exception cref="T:System.NotSupportedException">A NotSupportedException is thrown if the example object is <see langword="null" /> or is not a valid type | |
| which can be converted to a VectorCollection.</exception> | |
| <exception cref="T:System.NotSupportedException"><paramref name="value"/> is <see langword="null" /> or is not a valid type which can be converted to a <see cref="T:System.Windows.Media.VectorCollection" />.</exception> |
Comment on lines
+192
to
+193
| <exception cref="T:System.NotSupportedException">A NotSupportedException is thrown if "value" is <see langword="null" /> or not an instance of VectorCollection, | ||
| or if the destinationType isn't one of the valid destination types.</exception> |
Contributor
There was a problem hiding this comment.
Suggested change
| <exception cref="T:System.NotSupportedException">A NotSupportedException is thrown if "value" is <see langword="null" /> or not an instance of VectorCollection, | |
| or if the destinationType isn't one of the valid destination types.</exception> | |
| <exception cref="T:System.NotSupportedException"><paramref name="value"/> is <see langword="null" /> or not an instance of <see cref="T:System.Windows.Media.VectorCollection" />. | |
| -or- | |
| <paramref name="destinationTypes"/> is not one of the valid destination types.</exception> | |
Comment on lines
633
to
635
| <exception cref="T:System.ArgumentNullException">If ancestor is <see langword="null" />.</exception> | ||
| <exception cref="T:System.ArgumentException">If the ancestor Visual3D is not a ancestor of Visual.</exception> | ||
| <exception cref="T:System.InvalidOperationException">If the Visuals are not connected.</exception> |
Contributor
There was a problem hiding this comment.
Suggested change
| <exception cref="T:System.ArgumentNullException">If ancestor is <see langword="null" />.</exception> | |
| <exception cref="T:System.ArgumentException">If the ancestor Visual3D is not a ancestor of Visual.</exception> | |
| <exception cref="T:System.InvalidOperationException">If the Visuals are not connected.</exception> | |
| <exception cref="T:System.ArgumentNullException"><paramref name="ancestor"/> is <see langword="null" />.</exception> | |
| <exception cref="T:System.ArgumentException">The <paramref name="ancestor"/> Visual3D is not a ancestor of Visual.</exception> | |
| <exception cref="T:System.InvalidOperationException">The Visuals are not connected.</exception> | |
Comment on lines
153
to
155
| <exception cref="T:System.ArgumentNullException">An ArgumentNullException is thrown if the example object is <see langword="null" />.</exception> | ||
| <exception cref="T:System.ArgumentException">An ArgumentException is thrown if the example object is not <see langword="null" /> and is not a valid type | ||
| which can be converted to a CultureInfo.</exception> |
Contributor
There was a problem hiding this comment.
The description of the ArgumentException was describing the opposite behavior.
Suggested change
| <exception cref="T:System.ArgumentNullException">An ArgumentNullException is thrown if the example object is <see langword="null" />.</exception> | |
| <exception cref="T:System.ArgumentException">An ArgumentException is thrown if the example object is not <see langword="null" /> and is not a valid type | |
| which can be converted to a CultureInfo.</exception> | |
| <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <see langword="null" />.</exception> | |
| <exception cref="T:System.ArgumentException"><paramref name="value"/> is <see langword="null" /> or is not a valid type which can be converted to a <see cref="T:System.Globalization.CultureInfo" />.</exception> |
Comment on lines
196
to
198
| <exception cref="T:System.ArgumentNullException">An ArgumentNullException is thrown if the example object is <see langword="null" />.</exception> | ||
| <exception cref="T:System.ArgumentException">An ArgumentException is thrown if the example object is not <see langword="null" /> and is not a CultureInfo, | ||
| or if the destinationType isn't one of the valid destination types.</exception> |
Contributor
There was a problem hiding this comment.
Suggested change
| <exception cref="T:System.ArgumentNullException">An ArgumentNullException is thrown if the example object is <see langword="null" />.</exception> | |
| <exception cref="T:System.ArgumentException">An ArgumentException is thrown if the example object is not <see langword="null" /> and is not a CultureInfo, | |
| or if the destinationType isn't one of the valid destination types.</exception> | |
| <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <see langword="null" />.</exception> | |
| <exception cref="T:System.ArgumentException"><paramref name="value"/> is <see langword="null" /> or is not a <see cref="T:System.Globalization.CultureInfo" />. | |
| -or- | |
| <paramref name="destinationType"/> is not one of the valid destination types.</exception> |
Member
|
closing as abandoned |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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 GA 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