WPF/PresentationCore-MediaOther1: Generate XML files from most recent GA WPF source and update docs with DocsPortingTool #7220
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
ghost
added
the
area-Meta
carlossanlop
added
area-WPF
carlossanlop
reviewed
Oct 1, 2021
| </Parameters> | ||
| <Docs> | ||
| <param name="sourceFreezable">To be added.</param> | ||
| <summary>Implementation of <see cref="M:System.Windows.Freezable.CloneCore(System.Windows.Freezable)">Freezable.CloneCore</see>.</summary> |
Contributor
There was a problem hiding this comment.
These summaries aren't very helpful for the final user. Can you please change them to something describing the purpose of the API?
carlossanlop
reviewed
Oct 1, 2021
| <Parameter Name="sourceFreezable" Type="System.Windows.Freezable" /> | ||
| </Parameters> | ||
| <Docs> | ||
| <param name="sourceFreezable">To be added.</param> |
Contributor
There was a problem hiding this comment.
All these params are missing a description. Can you please add one?
carlossanlop
reviewed
Oct 1, 2021
| <exception cref="T:System.ArgumentNullException"> | ||
| <paramref name="ancestor" /> is <see langword="null" />.</exception> | ||
| <exception cref="T:System.ArgumentException">The specified <paramref name="ancestor" /> object is not an ancestor of this object.</exception> | ||
| <exception cref="T:System.InvalidOperationException">If the Visual3D and Visual are not connected.</exception> |
Contributor
There was a problem hiding this comment.
Suggested change
| <exception cref="T:System.InvalidOperationException">If the Visual3D and Visual are not connected.</exception> | |
| <exception cref="T:System.InvalidOperationException">The Visual3D and Visual are not connected.</exception> | |
| <summary>Returns the common ancestor of the visual object and another specified visual object.</summary> | ||
| <returns>The common ancestor of the current visual object and <paramref name="otherVisual" />; or <see langword="null" /> if no common ancestor is found.</returns> | ||
| <remarks>To be added.</remarks> | ||
| <exception cref="T:System.ArgumentNullException">If the argument is <see langword="null" />.</exception> |
Contributor
There was a problem hiding this comment.
Suggested change
| <exception cref="T:System.ArgumentNullException">If the argument is <see langword="null" />.</exception> | |
| <exception cref="T:System.ArgumentNullException"><paramref name="otherVisual"/> is <see langword="null" />.</exception> | |
| </Parameters> | ||
| <Docs> | ||
| <param name="hitTestParameters">To be added.</param> | ||
| <summary>Viewport3DVisual does not yet support Geometry hit testing.</summary> |
Contributor
There was a problem hiding this comment.
What does this mean for the final user? also missing param and returns descriptions.
Comment on lines
+497
to
+501
| <summary>Derived classes override this property to enable the Visual code to enumerate the Visual children. Derived classes need to return the number of children from this method. | ||
| By default a Visual does not have any children. | ||
| Remark: During this virtual method the Visual tree must not be modified.</summary> | ||
| <value>To be added.</value> | ||
| <remarks>To be added.</remarks> |
Contributor
There was a problem hiding this comment.
I assume they meant "during the execution of this virtual method"?:
Suggested change
| <summary>Derived classes override this property to enable the Visual code to enumerate the Visual children. Derived classes need to return the number of children from this method. | |
| By default a Visual does not have any children. | |
| Remark: During this virtual method the Visual tree must not be modified.</summary> | |
| <value>To be added.</value> | |
| <remarks>To be added.</remarks> | |
| <summary>Derived classes override this property to enable the Visual code to enumerate the Visual children. Derived classes need to return the number of children from this method. By default a Visual does not have any children.</summary> | |
| <value>To be added.</value> | |
| <remarks>During the execution of this virtual method, the Visual tree must not be modified.</remarks> | |
Comment on lines
+260
to
+267
| <summary>Derived class must implement to support Visual children. The method must return the child at the specified index. Index must be between 0 and GetVisualChildrenCount-1. | ||
| By default a Visual3D does not have any children. | ||
| Remark: | ||
| Need to lock down Visual tree during the callbacks. | ||
| During this virtual call it is not valid to modify the Visual tree. | ||
| It is okay to type this protected API to the 2D Visual. The only 2D Visual with 3D childern is the Viewport3DVisual which is sealed.</summary> | ||
| <returns>To be added.</returns> | ||
| <remarks>To be added.</remarks> |
Contributor
There was a problem hiding this comment.
Suggested change
| <summary>Derived class must implement to support Visual children. The method must return the child at the specified index. Index must be between 0 and GetVisualChildrenCount-1. | |
| By default a Visual3D does not have any children. | |
| Remark: | |
| Need to lock down Visual tree during the callbacks. | |
| During this virtual call it is not valid to modify the Visual tree. | |
| It is okay to type this protected API to the 2D Visual. The only 2D Visual with 3D childern is the Viewport3DVisual which is sealed.</summary> | |
| <returns>To be added.</returns> | |
| <remarks>To be added.</remarks> | |
| <summary>Derived classes must implement this to support Visual children. The method must return the child at the specified index. Index must be between 0 and <code>GetVisualChildrenCount</code>-1. By default a Visual3D does not have any children.</summary> | |
| <returns>To be added.</returns> | |
| <remarks> | |
| <format type="text/markdown"><![CDATA[ | |
| ## Remarks | |
| Need to lock down Visual tree during the callbacks. | |
| During this virtual call, it is not valid to modify the Visual tree. | |
| It is okay to type this protected API to the 2D Visual. The only 2D Visual with 3D children is the `Viewport3DVisual`, which is sealed. | |
| ]]></format> | |
| </remarks> | |
Comment on lines
+142
to
+143
| <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 Quaternion.</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 Quaternion.</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.Media3D.Quaternion" />.</exception> | |
Comment on lines
+229
to
+230
| <exception cref="T:System.NotSupportedException">A NotSupportedException is thrown if "value" is <see langword="null" /> or not an instance of Point4D, | ||
| 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 Point4D, | |
| 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.Media3D.Point4D" />. | |
| -or- | |
| <paramref name="destinationType"/> is not one of the valid destination types.</exception> | |
Comment on lines
+193
to
+194
| <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 Point4D.</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 Point4D.</exception> | |
| <exception cref="T:System.NotSupportedException"><paramref name="value"/> <see langword="null" /> or is not a valid type which can be converted to a <see cref="T:System.Windows.Media.Media3D.Point4D" />.</exception> | |
Comment on lines
+229
to
+230
| <exception cref="T:System.NotSupportedException">A NotSupportedException is thrown if "value" is <see langword="null" /> or not an instance of Point3D, | ||
| 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 Point3D, | |
| 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.Media3D.Point3D" />. | |
| -or- | |
| <paramref name="destinationType"/> is not one of the valid destination types.</exception> | |
Comment on lines
+193
to
+194
| <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 Point3D.</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 Point3D.</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.Media3D.Point3D" />.</exception> | |
Contributor
|
@ryalanms ping. We don't have much time to generate the updated intellisense. There are several suggestions that need to be applied. Here, and in the other PRs. |
Member
|
closing as abandoned |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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-MediaOther1: Generate XML files from most recent GA WPF source and update docs with DocsPortingTool
The GA 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.)