Skip to content

Commit 6ba1dcc

Browse files
lonitralonitra
committed
Port System.Drawing 9.0 docs
1 parent 60b5435 commit 6ba1dcc

38 files changed

+845
-373
lines changed

‎xml/System.Drawing.Drawing2D/GraphicsPath.xml‎

Lines changed: 68 additions & 15 deletions
Large diffs are not rendered by default.

‎xml/System.Drawing.Drawing2D/GraphicsPathIterator.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -308,6 +308,7 @@
308308
309309
]]></format>
310310
</remarks>
311+
<inheritdoc cref="M:System.Drawing.Drawing2D.GraphicsPathIterator.CopyData(System.Drawing.PointF[]@,System.Byte[]@,System.Int32,System.Int32)" />
311312
</Docs>
312313
</Member>
313314
<Member MemberName="Finalize">

‎xml/System.Drawing.Drawing2D/Matrix.xml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1569,6 +1569,7 @@ Matrix myMatrix = new Matrix(3, 5, 1, 2, 2, 4);
15691569
15701570
]]></format>
15711571
</remarks>
1572+
<inheritdoc cref="M:System.Drawing.Drawing2D.Matrix.TransformPoints(System.Drawing.Point[])" />
15721573
</Docs>
15731574
</Member>
15741575
<Member MemberName="TransformPoints">
@@ -1607,6 +1608,7 @@ Matrix myMatrix = new Matrix(3, 5, 1, 2, 2, 4);
16071608
<param name="pts">To be added.</param>
16081609
<summary>To be added.</summary>
16091610
<remarks>To be added.</remarks>
1611+
<inheritdoc cref="M:System.Drawing.Drawing2D.Matrix.TransformPoints(System.Drawing.Point[])" />
16101612
</Docs>
16111613
</Member>
16121614
<Member MemberName="TransformPoints">
@@ -1731,6 +1733,7 @@ Matrix myMatrix = new Matrix(3, 5, 1, 2, 2, 4);
17311733
17321734
]]></format>
17331735
</remarks>
1736+
<inheritdoc cref="M:System.Drawing.Drawing2D.Matrix.TransformVectors(System.Drawing.PointF[])" />
17341737
</Docs>
17351738
</Member>
17361739
<Member MemberName="TransformVectors">
@@ -1828,6 +1831,7 @@ Matrix myMatrix = new Matrix(3, 5, 1, 2, 2, 4);
18281831
<param name="pts">To be added.</param>
18291832
<summary>To be added.</summary>
18301833
<remarks>To be added.</remarks>
1834+
<inheritdoc cref="M:System.Drawing.Drawing2D.Matrix.TransformVectors(System.Drawing.PointF[])" />
18311835
</Docs>
18321836
</Member>
18331837
<Member MemberName="TransformVectors">
@@ -1866,6 +1870,7 @@ Matrix myMatrix = new Matrix(3, 5, 1, 2, 2, 4);
18661870
<param name="pts">To be added.</param>
18671871
<summary>To be added.</summary>
18681872
<remarks>To be added.</remarks>
1873+
<inheritdoc cref="M:System.Drawing.Drawing2D.Matrix.TransformVectors(System.Drawing.PointF[])" />
18691874
</Docs>
18701875
</Member>
18711876
<MemberGroup MemberName="Translate">
@@ -2043,6 +2048,7 @@ Matrix myMatrix = new Matrix(3, 5, 1, 2, 2, 4);
20432048
<param name="pts">An array of <see cref="T:System.Drawing.Point" /> structures that represents the points to transform.</param>
20442049
<summary>Multiplies each vector in an array by the matrix. The translation elements of this matrix (third row) are ignored.</summary>
20452050
<remarks>To be added.</remarks>
2051+
<inheritdoc cref="M:System.Drawing.Drawing2D.Matrix.TransformVectors(System.Drawing.PointF[])" />
20462052
</Docs>
20472053
</Member>
20482054
<Member MemberName="VectorTransformPoints">
@@ -2081,6 +2087,7 @@ Matrix myMatrix = new Matrix(3, 5, 1, 2, 2, 4);
20812087
<param name="pts">To be added.</param>
20822088
<summary>To be added.</summary>
20832089
<remarks>To be added.</remarks>
2090+
<inheritdoc cref="M:System.Drawing.Drawing2D.Matrix.TransformVectors(System.Drawing.PointF[])" />
20842091
</Docs>
20852092
</Member>
20862093
</Members>

‎xml/System.Drawing.Drawing2D/PathGradientBrush.xml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,7 @@
152152
<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>
153153
<summary>Initializes a new instance of the <see cref="T:System.Drawing.Drawing2D.PathGradientBrush" /> class with the specified points.</summary>
154154
<remarks>To be added.</remarks>
155+
<inheritdoc cref="M:System.Drawing.Drawing2D.PathGradientBrush.#ctor(System.Drawing.PointF[])" />
155156
</Docs>
156157
</Member>
157158
<Member MemberName=".ctor">
@@ -242,6 +243,7 @@
242243
<param name="points">To be added.</param>
243244
<summary>To be added.</summary>
244245
<remarks>To be added.</remarks>
246+
<inheritdoc cref="M:System.Drawing.Drawing2D.PathGradientBrush.#ctor(System.Drawing.PointF[])" />
245247
</Docs>
246248
</Member>
247249
<Member MemberName=".ctor">
@@ -283,6 +285,7 @@
283285
<param name="points">To be added.</param>
284286
<summary>To be added.</summary>
285287
<remarks>To be added.</remarks>
288+
<inheritdoc cref="M:System.Drawing.Drawing2D.PathGradientBrush.#ctor(System.Drawing.PointF[])" />
286289
</Docs>
287290
</Member>
288291
<Member MemberName=".ctor">
@@ -326,6 +329,7 @@
326329
<param name="points">To be added.</param>
327330
<summary>To be added.</summary>
328331
<remarks>To be added.</remarks>
332+
<inheritdoc cref="M:System.Drawing.Drawing2D.PathGradientBrush.#ctor(System.Drawing.PointF[],System.Drawing.Drawing2D.WrapMode)" />
329333
</Docs>
330334
</Member>
331335
<Member MemberName=".ctor">
@@ -369,6 +373,7 @@
369373
<param name="points">To be added.</param>
370374
<summary>To be added.</summary>
371375
<remarks>To be added.</remarks>
376+
<inheritdoc cref="M:System.Drawing.Drawing2D.PathGradientBrush.#ctor(System.Drawing.PointF[])" />
372377
</Docs>
373378
</Member>
374379
<Member MemberName=".ctor">
@@ -404,6 +409,7 @@
404409
<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>
405410
<summary>Initializes a new instance of the <see cref="T:System.Drawing.Drawing2D.PathGradientBrush" /> class with the specified points and wrap mode.</summary>
406411
<remarks>To be added.</remarks>
412+
<inheritdoc cref="M:System.Drawing.Drawing2D.PathGradientBrush.#ctor(System.Drawing.PointF[],System.Drawing.Drawing2D.WrapMode)" />
407413
</Docs>
408414
</Member>
409415
<Member MemberName=".ctor">

‎xml/System.Drawing.Drawing2D/PathPointType.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@
103103
<MemberValue>3</MemberValue>
104104
<Docs>
105105
<summary>A cubic Bézier curve.</summary>
106+
<inheritdoc cref="F:System.Drawing.Drawing2D.PathPointType.Bezier" />
106107
</Docs>
107108
</Member>
108109
<Member MemberName="CloseSubpath">

‎xml/System.Drawing.Imaging.Effects/BlackSaturationCurveEffect.xml‎

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,10 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>To be added.</summary>
17+
<summary>
18+
<para>Sets the black saturation of an image. The black saturation is the point at which the darkest areas of the image</para>
19+
<para>are converted to black.</para>
20+
</summary>
1821
<remarks>To be added.</remarks>
1922
</Docs>
2023
<Members>
@@ -35,10 +38,17 @@
3538
<Parameter Name="blackSaturation" Type="System.Int32" />
3639
</Parameters>
3740
<Docs>
38-
<param name="channel">To be added.</param>
39-
<param name="blackSaturation">To be added.</param>
40-
<summary>To be added.</summary>
41+
<param name="channel">The channel or channels that the effect is applied to.</param>
42+
<param name="blackSaturation">
43+
<para>A value of t specifies that the interval [t, 255] is mapped linearly to the interval [0, 255]. For example, if</para>
44+
<para>
45+
<paramref name="blackSaturation" /> is equal to 15, then color channel values in the interval [15, 255] are adjusted</para>
46+
<para>so that they spread out over the interval [0, 255]. Color channel values less than 15 are set to 0.</para>
47+
</param>
48+
<summary>Creates a new <see cref="T:System.Drawing.Imaging.Effects.BlackSaturationCurveEffect" /> with the given parameters.</summary>
4149
<remarks>To be added.</remarks>
50+
<exception cref="T:System.ArgumentException">
51+
<paramref name="blackSaturation" /> is less than 0 or greater than 254.</exception>
4252
</Docs>
4353
</Member>
4454
<Member MemberName="BlackSaturation">
@@ -57,7 +67,12 @@
5767
<ReturnType>System.Int32</ReturnType>
5868
</ReturnValue>
5969
<Docs>
60-
<summary>To be added.</summary>
70+
<summary>
71+
<para>A value of t specifies that the interval [t, 255] is mapped linearly to the interval [0, 255]. For example, if</para>
72+
<para>
73+
<see cref="P:System.Drawing.Imaging.Effects.BlackSaturationCurveEffect.BlackSaturation" /> is equal to 15, then color channel values in the interval [15, 255] are adjusted</para>
74+
<para>so that they spread out over the interval [0, 255]. Color channel values less than 15 are set to 0.</para>
75+
</summary>
6176
<value>To be added.</value>
6277
<remarks>To be added.</remarks>
6378
</Docs>

‎xml/System.Drawing.Imaging.Effects/BlurEffect.xml‎

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>To be added.</summary>
17+
<summary>Applies a Gaussian blur.</summary>
1818
<remarks>To be added.</remarks>
1919
</Docs>
2020
<Members>
@@ -35,10 +35,21 @@
3535
<Parameter Name="expandEdge" Type="System.Boolean" />
3636
</Parameters>
3737
<Docs>
38-
<param name="radius">To be added.</param>
39-
<param name="expandEdge">To be added.</param>
40-
<summary>To be added.</summary>
38+
<param name="radius">
39+
<para>Real number that specifies the blur radius (the radius of the Gaussian convolution kernel) in pixels. The</para>
40+
<para>radius must be in the range 0 through 256. As the radius increases, the resulting bitmap becomes more blurry.</para>
41+
</param>
42+
<param name="expandEdge">
43+
<para>Boolean value that specifies whether the bitmap expands by an amount equal to the blur radius. If</para>
44+
<para>
45+
<see langword="true" />, the bitmap expands by an amount equal to the radius so that it can have soft edges. If</para>
46+
<para>
47+
<see langword="false" />, the bitmap remains the same size and the soft edges are clipped.</para>
48+
</param>
49+
<summary>Creates a new <see cref="T:System.Drawing.Imaging.Effects.BlurEffect" /> with the given parameters.</summary>
4150
<remarks>To be added.</remarks>
51+
<exception cref="T:System.ArgumentException">
52+
<paramref name="radius" /> is less than 0 or greater than 256.</exception>
4253
</Docs>
4354
</Member>
4455
<Member MemberName="ExpandEdge">
@@ -57,7 +68,13 @@
5768
<ReturnType>System.Boolean</ReturnType>
5869
</ReturnValue>
5970
<Docs>
60-
<summary>To be added.</summary>
71+
<summary>
72+
<para>Boolean value that specifies whether the bitmap expands by an amount equal to the blur radius. If</para>
73+
<para>
74+
<see langword="true" />, the bitmap expands by an amount equal to the radius so that it can have soft edges. If</para>
75+
<para>
76+
<see langword="false" />, the bitmap remains the same size and the soft edges are clipped.</para>
77+
</summary>
6178
<value>To be added.</value>
6279
<remarks>To be added.</remarks>
6380
</Docs>
@@ -78,7 +95,10 @@
7895
<ReturnType>System.Single</ReturnType>
7996
</ReturnValue>
8097
<Docs>
81-
<summary>To be added.</summary>
98+
<summary>
99+
<para>Real number that specifies the blur radius (the radius of the Gaussian convolution kernel) in pixels. The</para>
100+
<para>radius must be in the range 0 through 255. As the radius increases, the resulting bitmap becomes more blurry.</para>
101+
</summary>
82102
<value>To be added.</value>
83103
<remarks>To be added.</remarks>
84104
</Docs>

‎xml/System.Drawing.Imaging.Effects/BrightnessContrastEffect.xml‎

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>To be added.</summary>
17+
<summary>Changes the brightness and contrast of an image.</summary>
1818
<remarks>To be added.</remarks>
1919
</Docs>
2020
<Members>
@@ -35,10 +35,23 @@
3535
<Parameter Name="contrastLevel" Type="System.Int32" />
3636
</Parameters>
3737
<Docs>
38-
<param name="brightnessLevel">To be added.</param>
39-
<param name="contrastLevel">To be added.</param>
40-
<summary>To be added.</summary>
38+
<param name="brightnessLevel">
39+
<para>Integer in the range -255 through 255 that specifies the brightness level. If the value is 0, the brightness</para>
40+
<para>remains the same. As the value moves from 0 to 255, the brightness of the image increases. As the value moves</para>
41+
<para>from 0 to -255, the brightness of the image decreases.</para>
42+
</param>
43+
<param name="contrastLevel">
44+
<para>Integer in the range -100 through 100 that specifies the contrast level. If the value is 0, the contrast</para>
45+
<para>remains the same. As the value moves from 0 to 100, the contrast of the image increases. As the value moves</para>
46+
<para>from 0 to -100, the contrast of the image decreases.</para>
47+
</param>
48+
<summary>Creates a new <see cref="T:System.Drawing.Imaging.Effects.BrightnessContrastEffect" /> with the given parameters.</summary>
4149
<remarks>To be added.</remarks>
50+
<exception cref="T:System.ArgumentException">
51+
<para>
52+
<paramref name="brightnessLevel" /> is less than -255 or greater than 255 or <paramref name="contrastLevel" /></para>
53+
<para>is less than -100 or greater than 100.</para>
54+
</exception>
4255
</Docs>
4356
</Member>
4457
<Member MemberName="BrightnessLevel">
@@ -57,7 +70,11 @@
5770
<ReturnType>System.Int32</ReturnType>
5871
</ReturnValue>
5972
<Docs>
60-
<summary>To be added.</summary>
73+
<summary>
74+
<para>Integer in the range -255 through 255 that specifies the brightness level. If the value is 0, the brightness</para>
75+
<para>remains the same. As the value moves from 0 to 255, the brightness of the image increases. As the value moves</para>
76+
<para>from 0 to -255, the brightness of the image decreases.</para>
77+
</summary>
6178
<value>To be added.</value>
6279
<remarks>To be added.</remarks>
6380
</Docs>
@@ -78,7 +95,11 @@
7895
<ReturnType>System.Int32</ReturnType>
7996
</ReturnValue>
8097
<Docs>
81-
<summary>To be added.</summary>
98+
<summary>
99+
<para>Integer in the range -100 through 100 that specifies the contrast level. If the value is 0, the contrast</para>
100+
<para>remains the same. As the value moves from 0 to 100, the contrast of the image increases. As the value moves</para>
101+
<para>from 0 to -100, the contrast of the image decreases.</para>
102+
</summary>
82103
<value>To be added.</value>
83104
<remarks>To be added.</remarks>
84105
</Docs>

‎xml/System.Drawing.Imaging.Effects/ColorBalanceEffect.xml‎

Lines changed: 43 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>To be added.</summary>
17+
<summary>Adjusts the color balance of an image.</summary>
1818
<remarks>To be added.</remarks>
1919
</Docs>
2020
<Members>
@@ -36,11 +36,31 @@
3636
<Parameter Name="yellowBlue" Type="System.Int32" />
3737
</Parameters>
3838
<Docs>
39-
<param name="cyanRed">To be added.</param>
40-
<param name="magentaGreen">To be added.</param>
41-
<param name="yellowBlue">To be added.</param>
42-
<summary>To be added.</summary>
39+
<param name="cyanRed">
40+
<para>Integer in the range -100 through 100 that specifies a change in the amount of red in the image. If the value</para>
41+
<para>is 0, there is no change. As the value moves from 0 to 100, the amount of red in the image increases and the</para>
42+
<para>amount of cyan decreases. As the value moves from 0 to -100, the amount of red in the image decreases and the</para>
43+
<para>amount of cyan increases.</para>
44+
</param>
45+
<param name="magentaGreen">
46+
<para>Integer in the range -100 through 100 that specifies a change in the amount of green in the image. If the value</para>
47+
<para>is 0, there is no change. As the value moves from 0 to 100, the amount of green in the image increases and the</para>
48+
<para>amount of magenta decreases. As the value moves from 0 to -100, the amount of green in the image decreases and</para>
49+
<para>and the amount of magenta increases.</para>
50+
</param>
51+
<param name="yellowBlue">
52+
<para>Integer in the range -100 through 100 that specifies a change in the amount of blue in the image. If the value</para>
53+
<para>is 0, there is no change. As the value moves from 0 to 100, the amount of blue in the image increases and the</para>
54+
<para>amount of yellow decreases. As the value moves from 0 to -100, the amount of blue in the image decreases and</para>
55+
<para>the amount of yellow increases.</para>
56+
</param>
57+
<summary>Creates a new <see cref="T:System.Drawing.Imaging.Effects.ColorBalanceEffect" /> with the given parameters.</summary>
4358
<remarks>To be added.</remarks>
59+
<exception cref="T:System.ArgumentException">
60+
<para>
61+
<paramref name="cyanRed" />, <paramref name="magentaGreen" />, or <paramref name="yellowBlue" /> is less than</para>
62+
<para>-100 or greater than 100.</para>
63+
</exception>
4464
</Docs>
4565
</Member>
4666
<Member MemberName="CyanRed">
@@ -59,7 +79,12 @@
5979
<ReturnType>System.Int32</ReturnType>
6080
</ReturnValue>
6181
<Docs>
62-
<summary>To be added.</summary>
82+
<summary>
83+
<para>Integer in the range -100 through 100 that specifies a change in the amount of red in the image. If the value</para>
84+
<para>is 0, there is no change. As the value moves from 0 to 100, the amount of red in the image increases and the</para>
85+
<para>amount of cyan decreases. As the value moves from 0 to -100, the amount of red in the image decreases and the</para>
86+
<para>amount of cyan increases.</para>
87+
</summary>
6388
<value>To be added.</value>
6489
<remarks>To be added.</remarks>
6590
</Docs>
@@ -80,7 +105,12 @@
80105
<ReturnType>System.Int32</ReturnType>
81106
</ReturnValue>
82107
<Docs>
83-
<summary>To be added.</summary>
108+
<summary>
109+
<para>Integer in the range -100 through 100 that specifies a change in the amount of green in the image. If the value</para>
110+
<para>is 0, there is no change. As the value moves from 0 to 100, the amount of green in the image increases and the</para>
111+
<para>amount of magenta decreases. As the value moves from 0 to -100, the amount of green in the image decreases and</para>
112+
<para>and the amount of magenta increases.</para>
113+
</summary>
84114
<value>To be added.</value>
85115
<remarks>To be added.</remarks>
86116
</Docs>
@@ -101,7 +131,12 @@
101131
<ReturnType>System.Int32</ReturnType>
102132
</ReturnValue>
103133
<Docs>
104-
<summary>To be added.</summary>
134+
<summary>
135+
<para>Integer in the range -100 through 100 that specifies a change in the amount of blue in the image. If the value</para>
136+
<para>is 0, there is no change. As the value moves from 0 to 100, the amount of blue in the image increases and the</para>
137+
<para>amount of yellow decreases. As the value moves from 0 to -100, the amount of blue in the image decreases and</para>
138+
<para>the amount of yellow increases.</para>
139+
</summary>
105140
<value>To be added.</value>
106141
<remarks>To be added.</remarks>
107142
</Docs>

‎xml/System.Drawing.Imaging.Effects/ColorCurveEffect.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>To be added.</summary>
17+
<summary>Base class for several effects that can be applied to an image.</summary>
1818
<remarks>To be added.</remarks>
1919
</Docs>
2020
<Members>
@@ -34,7 +34,7 @@
3434
<ReturnType>System.Drawing.Imaging.Effects.CurveChannel</ReturnType>
3535
</ReturnValue>
3636
<Docs>
37-
<summary>To be added.</summary>
37+
<summary>The channel or channels that the effect is applied to.</summary>
3838
<value>To be added.</value>
3939
<remarks>To be added.</remarks>
4040
</Docs>

0 commit comments

Comments
 (0)