Skip to content

Port System.Drawing docs for .NET 9 #10243

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 11 commits into from
Sep 4, 2024
Merged

Port System.Drawing docs for .NET 9 #10243

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
6ba1dcc
Port System.Drawing 9.0 docs
lonitra Aug 12, 2024
c96c13d
update docs based on feedback
lonitra Aug 15, 2024
15b0572
missed a couple more feedback comments
lonitra Aug 15, 2024
7077c40
fix issues
lonitra Aug 15, 2024
d9c2e3c
issue fix
lonitra Aug 15, 2024
4154568
fix GraphicsPath.Warp
lonitra Aug 15, 2024
403d56b
Merge remote-tracking branch 'origin/main' into portsystemdrawing
lonitra Aug 19, 2024
f0b7e16
rerun porting tool
lonitra Aug 19, 2024
83b14b7
Apply suggestions from code review
lonitra Aug 27, 2024
c750425
additional updates based on feedback
lonitra Aug 27, 2024
d525201
Update xml/System.Drawing.Imaging/DitherType.xml
lonitra Aug 28, 2024
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
86 changes: 70 additions & 16 deletions xml/System.Drawing.Drawing2D/GraphicsPath.xml
View file
Open in desktop

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions xml/System.Drawing.Drawing2D/GraphicsPathIterator.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,7 @@
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Drawing.Drawing2D.GraphicsPathIterator.CopyData(System.Drawing.PointF[]@,System.Byte[]@,System.Int32,System.Int32)" />
</Docs>
</Member>
<Member MemberName="Count">
Expand Down Expand Up @@ -354,6 +355,7 @@

]]></format>
</remarks>
<inheritdoc cref="M:System.Drawing.Drawing2D.GraphicsPathIterator.CopyData(System.Drawing.PointF[]@,System.Byte[]@,System.Int32,System.Int32)" />
</Docs>
</Member>
<Member MemberName="Enumerate">
Expand Down Expand Up @@ -384,6 +386,7 @@
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Drawing.Drawing2D.GraphicsPathIterator.CopyData(System.Drawing.PointF[]@,System.Byte[]@,System.Int32,System.Int32)" />
</Docs>
</Member>
<Member MemberName="Finalize">
Expand Down
7 changes: 7 additions & 0 deletions xml/System.Drawing.Drawing2D/Matrix.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1569,6 +1569,7 @@ Matrix myMatrix = new Matrix(3, 5, 1, 2, 2, 4);

]]></format>
</remarks>
<inheritdoc cref="M:System.Drawing.Drawing2D.Matrix.TransformPoints(System.Drawing.Point[])" />
</Docs>
</Member>
<Member MemberName="TransformPoints">
Expand Down Expand Up @@ -1607,6 +1608,7 @@ Matrix myMatrix = new Matrix(3, 5, 1, 2, 2, 4);
<param name="pts">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Drawing.Drawing2D.Matrix.TransformPoints(System.Drawing.Point[])" />
</Docs>
</Member>
<Member MemberName="TransformPoints">
Expand Down Expand Up @@ -1731,6 +1733,7 @@ Matrix myMatrix = new Matrix(3, 5, 1, 2, 2, 4);

]]></format>
</remarks>
<inheritdoc cref="M:System.Drawing.Drawing2D.Matrix.TransformVectors(System.Drawing.PointF[])" />
</Docs>
</Member>
<Member MemberName="TransformVectors">
Expand Down Expand Up @@ -1828,6 +1831,7 @@ Matrix myMatrix = new Matrix(3, 5, 1, 2, 2, 4);
<param name="pts">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Drawing.Drawing2D.Matrix.TransformVectors(System.Drawing.PointF[])" />
</Docs>
</Member>
<Member MemberName="TransformVectors">
Expand Down Expand Up @@ -1866,6 +1870,7 @@ Matrix myMatrix = new Matrix(3, 5, 1, 2, 2, 4);
<param name="pts">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Drawing.Drawing2D.Matrix.TransformVectors(System.Drawing.PointF[])" />
</Docs>
</Member>
<MemberGroup MemberName="Translate">
Expand Down Expand Up @@ -2043,6 +2048,7 @@ Matrix myMatrix = new Matrix(3, 5, 1, 2, 2, 4);
<param name="pts">An array of <see cref="T:System.Drawing.Point" /> structures that represents the points to transform.</param>
<summary>Multiplies each vector in an array by the matrix. The translation elements of this matrix (third row) are ignored.</summary>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Drawing.Drawing2D.Matrix.TransformVectors(System.Drawing.PointF[])" />
</Docs>
</Member>
<Member MemberName="VectorTransformPoints">
Expand Down Expand Up @@ -2081,6 +2087,7 @@ Matrix myMatrix = new Matrix(3, 5, 1, 2, 2, 4);
<param name="pts">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Drawing.Drawing2D.Matrix.TransformVectors(System.Drawing.PointF[])" />
</Docs>
</Member>
</Members>
Expand Down
6 changes: 6 additions & 0 deletions xml/System.Drawing.Drawing2D/PathGradientBrush.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@
<param name="points">An array of <see cref="T:System.Drawing.Point" /> structures that represents the points that make up the vertices of the path.</param>
<summary>Initializes a new instance of the <see cref="T:System.Drawing.Drawing2D.PathGradientBrush" /> class with the specified points.</summary>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Drawing.Drawing2D.PathGradientBrush.#ctor(System.Drawing.PointF[])" />
</Docs>
</Member>
<Member MemberName=".ctor">
Expand Down Expand Up @@ -242,6 +243,7 @@
<param name="points">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Drawing.Drawing2D.PathGradientBrush.#ctor(System.Drawing.PointF[])" />
</Docs>
</Member>
<Member MemberName=".ctor">
Expand Down Expand Up @@ -283,6 +285,7 @@
<param name="points">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Drawing.Drawing2D.PathGradientBrush.#ctor(System.Drawing.PointF[])" />
</Docs>
</Member>
<Member MemberName=".ctor">
Expand Down Expand Up @@ -326,6 +329,7 @@
<param name="points">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Drawing.Drawing2D.PathGradientBrush.#ctor(System.Drawing.PointF[],System.Drawing.Drawing2D.WrapMode)" />
</Docs>
</Member>
<Member MemberName=".ctor">
Expand Down Expand Up @@ -369,6 +373,7 @@
<param name="points">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Drawing.Drawing2D.PathGradientBrush.#ctor(System.Drawing.PointF[])" />
</Docs>
</Member>
<Member MemberName=".ctor">
Expand Down Expand Up @@ -404,6 +409,7 @@
<param name="wrapMode">A <see cref="T:System.Drawing.Drawing2D.WrapMode" /> that specifies how fills drawn with this <see cref="T:System.Drawing.Drawing2D.PathGradientBrush" /> are tiled.</param>
<summary>Initializes a new instance of the <see cref="T:System.Drawing.Drawing2D.PathGradientBrush" /> class with the specified points and wrap mode.</summary>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Drawing.Drawing2D.PathGradientBrush.#ctor(System.Drawing.PointF[],System.Drawing.Drawing2D.WrapMode)" />
</Docs>
</Member>
<Member MemberName=".ctor">
Expand Down
1 change: 1 addition & 0 deletions xml/System.Drawing.Drawing2D/PathPointType.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@
<MemberValue>3</MemberValue>
<Docs>
<summary>A cubic Bézier curve.</summary>
<inheritdoc cref="F:System.Drawing.Drawing2D.PathPointType.Bezier" />
</Docs>
</Member>
<Member MemberName="CloseSubpath">
Expand Down
25 changes: 19 additions & 6 deletions xml/System.Drawing.Imaging.Effects/BlackSaturationCurveEffect.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>Sets the black saturation of an image. The black saturation is the point at which the darkest areas of the image are converted to black.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -35,10 +35,17 @@
<Parameter Name="blackSaturation" Type="System.Int32" />
</Parameters>
<Docs>
<param name="channel">To be added.</param>
<param name="blackSaturation">To be added.</param>
<summary>To be added.</summary>
<param name="channel">The channel or channels that the effect is applied to.</param>
<param name="blackSaturation">
<para>A value of t specifies that the interval [t, 255] is mapped linearly to the interval [0, 255]. For example, if</para>
<para>
<paramref name="blackSaturation" /> is equal to 15, then color channel values in the interval [15, 255] are adjusted</para>
<para>so that they spread out over the interval [0, 255]. Color channel values less than 15 are set to 0.</para>
</param>
<summary>Creates a new <see cref="T:System.Drawing.Imaging.Effects.BlackSaturationCurveEffect" /> with the given parameters.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
<paramref name="blackSaturation" /> is less than 0 or greater than 254.</exception>
</Docs>
</Member>
<Member MemberName="BlackSaturation">
Expand All @@ -57,9 +64,15 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the black saturation value.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>
<para>
A value of t specifies that the interval [t, 255] is mapped linearly to the interval [0, 255]. For example, if
<see cref="P:System.Drawing.Imaging.Effects.BlackSaturationCurveEffect.BlackSaturation" /> is equal to 15, then color channel values in the interval [15, 255] are adjusted
so that they spread out over the interval [0, 255]. Color channel values less than 15 are set to 0.
</para>
</remarks>
</Docs>
</Member>
</Members>
Expand Down
25 changes: 17 additions & 8 deletions xml/System.Drawing.Imaging.Effects/BlurEffect.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>Applies a Gaussian blur.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -35,10 +35,15 @@
<Parameter Name="expandEdge" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="radius">To be added.</param>
<param name="expandEdge">To be added.</param>
<summary>To be added.</summary>
<param name="radius">
<para>
<see langword="true" /> to expand the bitmap by an amount equal to the blur radius so it can have soft edges. <see langword="false" /> to keep the bitmap the same size and clip the soft edges.
</para>
</param>
<summary>Creates a new <see cref="T:System.Drawing.Imaging.Effects.BlurEffect" /> with the given parameters.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
<paramref name="radius" /> is less than 0 or greater than 256.</exception>
</Docs>
</Member>
<Member MemberName="ExpandEdge">
Expand All @@ -57,8 +62,12 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>
Gets a value that indicates whether the bitmap expands by an amount equal to the blur radius.
</summary>
<value>
<see langword="true" /> if the bitmap expands by an amount equal to the radius so that it can have soft edges. <see langword="false" /> if the bitmap remains the same size and the soft edges are clipped.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -78,9 +87,9 @@
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the blur radius (the radius of the Gaussian convolution kernel) in pixels.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>The radius must be in the range 0 through 255. As the radius increases, the resulting bitmap becomes more blurry.</remarks>
</Docs>
</Member>
</Members>
Expand Down
33 changes: 25 additions & 8 deletions xml/System.Drawing.Imaging.Effects/BrightnessContrastEffect.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>Changes the brightness and contrast of an image.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -35,10 +35,23 @@
<Parameter Name="contrastLevel" Type="System.Int32" />
</Parameters>
<Docs>
<param name="brightnessLevel">To be added.</param>
<param name="contrastLevel">To be added.</param>
<summary>To be added.</summary>
<param name="brightnessLevel">
<para>Integer in the range -255 through 255 that specifies the brightness level. If the value is 0, the brightness</para>
<para>remains the same. As the value moves from 0 to 255, the brightness of the image increases. As the value moves</para>
<para>from 0 to -255, the brightness of the image decreases.</para>
</param>
<param name="contrastLevel">
<para>Integer in the range -100 through 100 that specifies the contrast level. If the value is 0, the contrast</para>
<para>remains the same. As the value moves from 0 to 100, the contrast of the image increases. As the value moves</para>
<para>from 0 to -100, the contrast of the image decreases.</para>
</param>
<summary>Creates a new <see cref="T:System.Drawing.Imaging.Effects.BrightnessContrastEffect" /> with the given parameters.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
<para>
<paramref name="brightnessLevel" /> is less than -255 or greater than 255 or <paramref name="contrastLevel" /></para>
<para>is less than -100 or greater than 100.</para>
</exception>
</Docs>
</Member>
<Member MemberName="BrightnessLevel">
Expand All @@ -57,7 +70,11 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>
<para>Integer in the range -255 through 255 that specifies the brightness level. If the value is 0, the brightness</para>
<para>remains the same. As the value moves from 0 to 255, the brightness of the image increases. As the value moves</para>
<para>from 0 to -255, the brightness of the image decreases.</para>
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -78,9 +95,9 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the contrast level.</summary>
<value>An integer in the range -100 through 100 that specifies the contrast level.</value>
<remarks>If the value is 0, the contrast remains the same. As the value moves from 0 to 100, the contrast of the image increases. As the value moves from 0 to -100, the contrast of the image decreases.</remarks>
</Docs>
</Member>
</Members>
Expand Down
60 changes: 49 additions & 11 deletions xml/System.Drawing.Imaging.Effects/ColorBalanceEffect.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>Adjusts the color balance of an image.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -36,11 +36,37 @@
<Parameter Name="yellowBlue" Type="System.Int32" />
</Parameters>
<Docs>
<param name="cyanRed">To be added.</param>
<param name="magentaGreen">To be added.</param>
<param name="yellowBlue">To be added.</param>
<summary>To be added.</summary>
<param name="cyanRed">
<para>
Integer in the range -100 through 100 that specifies a change in the amount of red in the image. If the value
is 0, there is no change. As the value moves from 0 to 100, the amount of red in the image increases and the
amount of cyan decreases. As the value moves from 0 to -100, the amount of red in the image decreases and the
amount of cyan increases.
</para>
</param>
<param name="magentaGreen">
<para>
Integer in the range -100 through 100 that specifies a change in the amount of green in the image. If the value
is 0, there is no change. As the value moves from 0 to 100, the amount of green in the image increases and the
amount of magenta decreases. As the value moves from 0 to -100, the amount of green in the image decreases and
and the amount of magenta increases.
</para>
</param>
<param name="yellowBlue">
<para>
Integer in the range -100 through 100 that specifies a change in the amount of blue in the image. If the value
is 0, there is no change. As the value moves from 0 to 100, the amount of blue in the image increases and the
amount of yellow decreases. As the value moves from 0 to -100, the amount of blue in the image decreases and
the amount of yellow increases.
</para>
</param>
<summary>Creates a new <see cref="T:System.Drawing.Imaging.Effects.ColorBalanceEffect" /> with the given parameters.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
<para>
<paramref name="cyanRed" />, <paramref name="magentaGreen" />, or <paramref name="yellowBlue" /> is less than</para>
<para>-100 or greater than 100.</para>
</exception>
</Docs>
</Member>
<Member MemberName="CyanRed">
Expand All @@ -59,8 +85,12 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the amount of cyanRed in the image.</summary>
<value>
The value can range from -100 through 100. As the value moves from 0 to 100, the amount of red in the image increases and the
amount of cyan decreases. As the value moves from 0 to -100, the amount of red in the image decreases and the
amount of cyan increases.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -80,8 +110,12 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the amount of magentaGreen in the image</summary>
<value>
The value can range from -100 through 100. As the value moves from 0 to 100, the amount of green in the image increases and the
amount of magenta decreases. As the value moves from 0 to -100, the amount of green in the image decreases and
and the amount of magenta increases.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -101,8 +135,12 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets the amount of yellowBlue in the image.</summary>
<value>
The value can range from -100 through 100. As the value moves from 0 to 100, the amount of blue in the image increases and the
amount of yellow decreases. As the value moves from 0 to -100, the amount of blue in the image decreases and
the amount of yellow increases.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
Loading