Skip to content

Commit c96c13d

Browse files
lonitralonitra
committed
update docs based on feedback
1 parent 6ba1dcc commit c96c13d

21 files changed

+235
-274
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6282,7 +6282,7 @@
62826282
<Parameter Name="flatness" Type="System.Single" Index="4" FrameworkAlternate="windowsdesktop-9.0;dotnet-plat-ext-9.0;net-9.0" />
62836283
</Parameters>
62846284
<Docs>
6285-
<param name="destPoints">
6285+
<param name="destPoints">fixthis
62866286
<para>An array of points that define a parallelogram to which the rectangle defined by <paramref name="srcRect" /></para>
62876287
<para>is transformed. The array can contain either three or four elements. If the array contains three elements,</para>
62886288
<para>the lower-right corner of the parallelogram is implied by the first three points.</para>

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

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,7 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
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>
17+
<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>
2118
<remarks>To be added.</remarks>
2219
</Docs>
2320
<Members>
@@ -67,14 +64,15 @@
6764
<ReturnType>System.Int32</ReturnType>
6865
</ReturnValue>
6966
<Docs>
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>
67+
<summary>Gets the black saturation value.</summary>
7668
<value>To be added.</value>
77-
<remarks>To be added.</remarks>
69+
<remarks>
70+
<para>
71+
A value of t specifies that the interval [t, 255] is mapped linearly to the interval [0, 255]. For example, if
72+
<see cref="P:System.Drawing.Imaging.Effects.BlackSaturationCurveEffect.BlackSaturation" /> is equal to 15, then color channel values in the interval [15, 255] are adjusted
73+
so that they spread out over the interval [0, 255]. Color channel values less than 15 are set to 0.
74+
</para>
75+
</remarks>
7876
</Docs>
7977
</Member>
8078
</Members>

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

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,9 @@
3636
</Parameters>
3737
<Docs>
3838
<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>
4639
<para>
47-
<see langword="false" />, the bitmap remains the same size and the soft edges are clipped.</para>
40+
<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.
41+
</para>
4842
</param>
4943
<summary>Creates a new <see cref="T:System.Drawing.Imaging.Effects.BlurEffect" /> with the given parameters.</summary>
5044
<remarks>To be added.</remarks>
@@ -69,13 +63,10 @@
6963
</ReturnValue>
7064
<Docs>
7165
<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>
78-
<value>To be added.</value>
66+
<para>Gets a value that indicates whether the bitmap expands by an amount equal to the blur radius.</summary>
67+
<value>
68+
<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.
69+
</value>
7970
<remarks>To be added.</remarks>
8071
</Docs>
8172
</Member>
@@ -95,12 +86,9 @@
9586
<ReturnType>System.Single</ReturnType>
9687
</ReturnValue>
9788
<Docs>
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>
89+
<summary>Gets the blur radius (the radius of the Gaussian convolution kernel) in pixels.</summary>
10290
<value>To be added.</value>
103-
<remarks>To be added.</remarks>
91+
<remarks>The radius must be in the range 0 through 255. As the radius increases, the resulting bitmap becomes more blurry.</remarks>
10492
</Docs>
10593
</Member>
10694
</Members>

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

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -95,13 +95,9 @@
9595
<ReturnType>System.Int32</ReturnType>
9696
</ReturnValue>
9797
<Docs>
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>
103-
<value>To be added.</value>
104-
<remarks>To be added.</remarks>
98+
<summary>Gets the contrast level.</summary>
99+
<value>An integer in the range -100 through 100 that specifies the contrast level.</value>
100+
<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>
105101
</Docs>
106102
</Member>
107103
</Members>

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

Lines changed: 36 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -37,22 +37,28 @@
3737
</Parameters>
3838
<Docs>
3939
<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>
40+
<para>
41+
Integer in the range -100 through 100 that specifies a change in the amount of red in the image. If the value
42+
is 0, there is no change. As the value moves from 0 to 100, the amount of red in the image increases and the
43+
amount of cyan decreases. As the value moves from 0 to -100, the amount of red in the image decreases and the
44+
amount of cyan increases.
45+
</para>
4446
</param>
4547
<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>
48+
<para>
49+
Integer in the range -100 through 100 that specifies a change in the amount of green in the image. If the value
50+
is 0, there is no change. As the value moves from 0 to 100, the amount of green in the image increases and the
51+
amount of magenta decreases. As the value moves from 0 to -100, the amount of green in the image decreases and
52+
and the amount of magenta increases.
53+
</para>
5054
</param>
5155
<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+
<para>
57+
Integer in the range -100 through 100 that specifies a change in the amount of blue in the image. If the value
58+
is 0, there is no change. As the value moves from 0 to 100, the amount of blue in the image increases and the
59+
amount of yellow decreases. As the value moves from 0 to -100, the amount of blue in the image decreases and
60+
the amount of yellow increases.
61+
</para>
5662
</param>
5763
<summary>Creates a new <see cref="T:System.Drawing.Imaging.Effects.ColorBalanceEffect" /> with the given parameters.</summary>
5864
<remarks>To be added.</remarks>
@@ -79,13 +85,12 @@
7985
<ReturnType>System.Int32</ReturnType>
8086
</ReturnValue>
8187
<Docs>
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>
88-
<value>To be added.</value>
88+
<summary>Gets the amount of cyanRed in the image.</summary>
89+
<value>
90+
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
91+
amount of cyan decreases. As the value moves from 0 to -100, the amount of red in the image decreases and the
92+
amount of cyan increases.
93+
</value>
8994
<remarks>To be added.</remarks>
9095
</Docs>
9196
</Member>
@@ -105,13 +110,12 @@
105110
<ReturnType>System.Int32</ReturnType>
106111
</ReturnValue>
107112
<Docs>
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>
114-
<value>To be added.</value>
113+
<summary>Gets the amount of magentaGreen in the image</summary>
114+
<value>
115+
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
116+
amount of magenta decreases. As the value moves from 0 to -100, the amount of green in the image decreases and
117+
and the amount of magenta increases.
118+
</value>
115119
<remarks>To be added.</remarks>
116120
</Docs>
117121
</Member>
@@ -131,13 +135,12 @@
131135
<ReturnType>System.Int32</ReturnType>
132136
</ReturnValue>
133137
<Docs>
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>
140-
<value>To be added.</value>
138+
<summary>Gets the amount of yellowBlue in the image.</summary>
139+
<value>
140+
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
141+
amount of yellow decreases. As the value moves from 0 to -100, the amount of blue in the image decreases and
142+
the amount of yellow increases.
143+
</value>
141144
<remarks>To be added.</remarks>
142145
</Docs>
143146
</Member>

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

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,8 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>
18-
<para>Allows modification of the color components of an image. Individual color component values are changed to entries</para>
19-
<para>in a series of lookup tables.</para>
20-
</summary>
21-
<remarks>To be added.</remarks>
17+
<summary>Allows modification of the color components of an image.</summary>
18+
<remarks>Individual color component values are changed to entries in a series of lookup tables.</remarks>
2219
</Docs>
2320
<Members>
2421
<Member MemberName=".ctor">

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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@
2626
<Docs>
2727
<summary>Color matrix adjustment effect.</summary>
2828
<remarks>
29-
<para></para>
30-
<para>See <see href="https://learn.microsoft.com/windows/win32/gdiplus/-gdiplus-recoloring-use">Recoloring</see> for</para>
31-
<para>examples of using a color matrix to adjust the colors of an image.</para>
32-
<para></para>
29+
<para>
30+
See <see href="https://learn.microsoft.com/windows/win32/gdiplus/-gdiplus-recoloring-use">Recoloring</see>
31+
for examples of using a color matrix to adjust the colors of an image.
32+
</para>
3333
</remarks>
3434
</Docs>
3535
<Members>
@@ -73,10 +73,9 @@
7373
<summary>The color transform matrix.</summary>
7474
<value>To be added.</value>
7575
<remarks>
76-
<para></para>
7776
<para>
7877
<see cref="T:System.Drawing.Imaging.ColorMatrix" /> is mutable, but effects do not support changing the matrix after creation.</para>
79-
<para></para>
78+
</para>
8079
</remarks>
8180
</Docs>
8281
</Member>

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

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,10 @@
3737
<Docs>
3838
<param name="channel">The channel or channels that the effect is applied to.</param>
3939
<param name="contrast">
40-
<para>A value in the range of -100 through 100. A value of 0 specifies no change in contrast. Positive values</para>
41-
<para>specify increased contrast and negative values specify decreased contrast.</para>
40+
<para>
41+
A value in the range of -100 through 100. A value of 0 specifies no change in contrast. Positive values
42+
specify increased contrast and negative values specify decreased contrast.
43+
</para>
4244
</param>
4345
<summary>Creates a new <see cref="T:System.Drawing.Imaging.Effects.ContrastCurveEffect" /> with the given <paramref name="contrast" /> adjustment value.</summary>
4446
<remarks>To be added.</remarks>
@@ -62,11 +64,8 @@
6264
<ReturnType>System.Int32</ReturnType>
6365
</ReturnValue>
6466
<Docs>
65-
<summary>
66-
<para>A value in the range of -100 through 100. A value of 0 specifies no change in contrast. Positive values</para>
67-
<para>specify increased contrast and negative values specify decreased contrast.</para>
68-
</summary>
69-
<value>To be added.</value>
67+
<summary>A value in the range of -100 through 100.</summary>
68+
<value>A value of 0 specifies no change in contrast. Positive values specify increased contrast and negative values specify decreased contrast.</value>
7069
<remarks>To be added.</remarks>
7170
</Docs>
7271
</Member>

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@
3737
<Docs>
3838
<param name="channel">The channel or channels that the effect is applied to.</param>
3939
<param name="density">
40-
<para>A value in the range of -256 through 256. A value of 0 specifies no change in density. Positive values specify</para>
41-
<para>increased density (lighter picture) and negative values specify decreased density (darker picture).</para>
40+
A value in the range of -256 through 256. A value of 0 specifies no change in density. Positive values specify
41+
increased density (lighter picture) and negative values specify decreased density (darker picture).
4242
</param>
4343
<summary>Creates a new <see cref="T:System.Drawing.Imaging.Effects.DensityCurveEffect" /> with the given <paramref name="density" />.</summary>
4444
<remarks>To be added.</remarks>
@@ -63,8 +63,8 @@
6363
</ReturnValue>
6464
<Docs>
6565
<summary>
66-
<para>A value in the range of -256 through 256. A value of 0 specifies no change in density. Positive values specify</para>
67-
<para>increased density (lighter picture) and negative values specify decreased density (darker picture).</para>
66+
A value in the range of -256 through 256. A value of 0 specifies no change in density. Positive values specify
67+
increased density (lighter picture) and negative values specify decreased density (darker picture).
6868
</summary>
6969
<value>To be added.</value>
7070
<remarks>To be added.</remarks>

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

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@
3737
<Docs>
3838
<param name="channel">The channel or channels that the effect is applied to.</param>
3939
<param name="exposure">
40-
<para>A value in the range of -256 through 256. A value of 0 specifies no change in exposure. Positive values</para>
41-
<para>specify increased exposure and negative values specify decreased exposure.</para>
40+
A value in the range of -256 through 256. A value of 0 specifies no change in exposure. Positive values
41+
specify increased exposure and negative values specify decreased exposure.
4242
</param>
4343
<summary>Creates a new <see cref="T:System.Drawing.Imaging.Effects.ExposureCurveEffect" /> with the given <paramref name="exposure" /> adjustment.</summary>
4444
<remarks>To be added.</remarks>
@@ -63,10 +63,12 @@
6363
</ReturnValue>
6464
<Docs>
6565
<summary>
66-
<para>A value in the range of -256 through 256. A value of 0 specifies no change in exposure. Positive values</para>
67-
<para>specify increased exposure and negative values specify decreased exposure.</para>
66+
Gets the exposure value.
6867
</summary>
69-
<value>To be added.</value>
68+
<value>
69+
A value in the range of -256 through 256. A value of 0 specifies no change in exposure. Positive values
70+
specify increased exposure and negative values specify decreased exposure.
71+
</value>
7072
<remarks>To be added.</remarks>
7173
</Docs>
7274
</Member>

0 commit comments

Comments
 (0)