Skip to content

Add documentation for WPF's System.Windows.Media.PenDashCap enum and System.Windows.Media.IAnimation interface #3018

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Aug 19, 2019
Merged

Add documentation for WPF's System.Windows.Media.PenDashCap enum and System.Windows.Media.IAnimation interface #3018

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
75e41ce
Add documentation for WPF's System.Windows.Media.PenDashCap enum and …
ryalanms Aug 15, 2019
63fb91d
Minor change to PenDashCap enumeration
Aug 15, 2019
fc81db1
Edited.
Aug 15, 2019
d0eec43
PR feedback
ryalanms Aug 15, 2019
69833b2
fix broken links
mairaw Aug 16, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions xml/System.Windows.Media.Animation/IAnimation.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>Provides support for animating a property value.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -35,13 +35,15 @@
<Parameter Name="animationClock" Type="System.Windows.Media.Animation.AnimationClock" />
</Parameters>
<Docs>
<param name="defaultOriginValue">To be added.</param>
<param name="defaultDestinationValue">To be added.</param>
<param name="animationClock">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="defaultOriginValue">The suggested origin value to provide the animation, which is used if the animation does not have its own concept of a start value. If this animation is the first in a composition chain, it is the snapshot value, if one is available, or the base property value, if it is not; otherwise, it is the value returned by the previous animation in the chain with an animation clock that is not <see cref="F:System.Windows.Media.Animation.ClockState.Stopped" />.</param>
<param name="defaultDestinationValue">The suggested destination value to provide the animation, which is used if the animation does not have its own concept of an end value. It is the base value if the animation is in the first composition layer of animations on a property; otherwise, it is the output value from the previous composition layer of animations for the property.</param>
<param name="animationClock">The animation clock that can generate the <see cref="P:System.Windows.Media.Animation.Clock.CurrentTime" /> or <see cref="P:System.Windows.Media.Animation.Clock.CurrentProgress" /> value to be used by the animation to generate its output value.</param>
<summary>Calculates the value this animation believes should be the current value for the property.</summary>
<returns>The value this animation believes should be the current value for the property.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>


9 changes: 5 additions & 4 deletions xml/System.Windows.Media/PenDashCap.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>To be added.</summary>
<summary>Describes the shape at the end of each dash segment.</summary>
Copy link
Member Author

Choose a reason for hiding this comment

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

Minor nitpick here: both ends of each dash are affected by the cap setting.

Copy link
Contributor

@carlossanlop carlossanlop Aug 19, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

Which cap setting are you referring to? Should this information be included as a remark somewhere within this file?

Copy link
Member Author

@ryalanms ryalanms Aug 19, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

PenDashCap (this enum) is the shape (the line cap) at the ends of each dash segment. If that doesn't seem clear, 'line cap' can be added to the main description:

 <summary>Describes the shape (the line cap) at the ends of each dash segment.</summary>

<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -34,7 +34,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>A cap that does not extend past the last point of the line. It is comparable to no line cap.</summary>
</Docs>
</Member>
<Member MemberName="Round">
Expand All @@ -54,7 +54,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>A semicircle that has a diameter equal to the line thickness.</summary>
</Docs>
</Member>
<Member MemberName="Triangle">
Expand All @@ -74,8 +74,9 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>An isosceles right triangle whose base length is equal to the thickness of the line.</summary>
</Docs>
</Member>
</Members>
</Type>