Skip to content

Commit 45e424b

Browse files
lonitralonitra
authored
Add Remaining Documentation for System.Drawing for .NET 9 (dotnet#10372)
1 parent 35a8cb8 commit 45e424b

File tree

14 files changed

+65
-30
lines changed

14 files changed

+65
-30
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1650,6 +1650,7 @@
16501650
16511651
]]></format>
16521652
</remarks>
1653+
<inheritdoc cref="M:System.Drawing.Drawing2D.GraphicsPath.AddCurve(System.Drawing.PointF[],System.Int32,System.Int32,System.Single)" />
16531654
</Docs>
16541655
</Member>
16551656
<Member MemberName="AddCurve">

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1647,6 +1647,7 @@ Matrix myMatrix = new Matrix(3, 5, 1, 2, 2, 4);
16471647
<param name="pts">To be added.</param>
16481648
<summary>To be added.</summary>
16491649
<remarks>To be added.</remarks>
1650+
<inheritdoc cref="M:System.Drawing.Drawing2D.Matrix.TransformPoints(System.Drawing.Point[])" />
16501651
</Docs>
16511652
</Member>
16521653
<MemberGroup MemberName="TransformVectors">

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -373,7 +373,7 @@
373373
<param name="points">To be added.</param>
374374
<summary>To be added.</summary>
375375
<remarks>To be added.</remarks>
376-
<inheritdoc cref="M:System.Drawing.Drawing2D.PathGradientBrush.#ctor(System.Drawing.PointF[])" />
376+
<inheritdoc cref="M:System.Drawing.Drawing2D.PathGradientBrush.#ctor(System.Drawing.PointF[],System.Drawing.Drawing2D.WrapMode)" />
377377
</Docs>
378378
</Member>
379379
<Member MemberName=".ctor">

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

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,13 @@
3636
</Parameters>
3737
<Docs>
3838
<param name="radius">
39-
<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>
39+
Real number that specifies the blur radius (the radius of the Gaussian convolution kernel) in pixels. The
40+
radius must be in the range 0 through 256. As the radius increases, the resulting bitmap becomes more blurry.
4241
</param>
43-
<summary>Creates a new <see cref="T:System.Drawing.Imaging.Effects.BlurEffect" /> with the given parameters.</summary>
42+
<param name="expandEdge">
43+
<see langword="true"/> to expand the bitmap by an amount equal to the blur radius so that it can have soft edges; <see langword="false"/> to keep the bitmap the same size and clip the soft edges.
44+
</param>
45+
<summary>Creates a new <see cref="T:System.Drawing.Imaging.Effects.BlurEffect" /> with the specified blur radius.</summary>
4446
<remarks>To be added.</remarks>
4547
<exception cref="T:System.ArgumentException">
4648
<paramref name="radius" /> is less than 0 or greater than 256.</exception>

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,12 @@
4747
</Docs>
4848
</Member>
4949
<Member MemberName="Dispose">
50-
<MemberSignature Language="C#" Value="public virtual void Dispose (bool disposing);" />
51-
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
50+
<MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
51+
<MemberSignature Language="ILAsm" Value=".method protected hidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
5252
<MemberSignature Language="DocId" Value="M:System.Drawing.Imaging.Effects.Effect.Dispose(System.Boolean)" />
53-
<MemberSignature Language="VB.NET" Value="Public Overridable Sub Dispose (disposing As Boolean)" />
53+
<MemberSignature Language="VB.NET" Value="protected Overridable Sub Dispose (disposing As Boolean)" />
5454
<MemberSignature Language="F#" Value="abstract member Dispose : bool -&gt; unit&#xA;override this.Dispose : bool -&gt; unit" Usage="effect.Dispose disposing" />
55-
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual void Dispose(bool disposing);" />
55+
<MemberSignature Language="C++ CLI" Value="protected:&#xA; virtual void Dispose(bool disposing);" />
5656
<MemberType>Method</MemberType>
5757
<AssemblyInfo>
5858
<AssemblyName>System.Drawing.Common</AssemblyName>
@@ -87,7 +87,7 @@
8787
</ReturnValue>
8888
<Parameters />
8989
<Docs>
90-
<summary>To be added.</summary>
90+
<summary>Cleans up Windows resources for this <see cref="T:System.Drawing.Imaging.Effects.Effect" />.</summary>
9191
<remarks>To be added.</remarks>
9292
</Docs>
9393
</Member>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
</AssemblyInfo>
3232
<Parameters />
3333
<Docs>
34-
<summary>To be added.</summary>
34+
<summary>Creates a <see cref="T:System.Drawing.Imaging.Effects.ColorMatrixEffect" /> that converts an image to grayscale.</summary>
3535
<remarks>To be added.</remarks>
3636
</Docs>
3737
</Member>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
</AssemblyInfo>
3232
<Parameters />
3333
<Docs>
34-
<summary>To be added.</summary>
34+
<summary>Creates a <see cref="T:System.Drawing.Imaging.Effects.ColorMatrixEffect" /> that inverts the colors in an image.</summary>
3535
<remarks>To be added.</remarks>
3636
</Docs>
3737
</Member>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
</AssemblyInfo>
3232
<Parameters />
3333
<Docs>
34-
<summary>To be added.</summary>
34+
<summary>Creates a new <see cref="T:System.Drawing.Imaging.Effects.ColorMatrixEffect" /> that converts an image to sepia.</summary>
3535
<remarks>To be added.</remarks>
3636
</Docs>
3737
</Member>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
</AssemblyInfo>
3232
<Parameters />
3333
<Docs>
34-
<summary>To be added.</summary>
34+
<summary>Creates a new <see cref="T:System.Drawing.Imaging.Effects.ColorMatrixEffect" /> that makes colors more vivid.</summary>
3535
<remarks>To be added.</remarks>
3636
</Docs>
3737
</Member>

‎xml/System.Drawing.Imaging/ColorMatrix.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@
162162
</Parameter>
163163
</Parameters>
164164
<Docs>
165-
<param name="newColorMatrix">To be added.</param>
165+
<param name="newColorMatrix">The values of the elements of the new matrix.</param>
166166
<summary>Initializes a new instance of the <see cref="T:System.Drawing.Imaging.ColorMatrix" /> class with the elements in the specified matrix.</summary>
167167
<remarks>To be added.</remarks>
168168
<exception cref="T:System.ArgumentOutOfRangeException">

‎xml/System.Drawing.Imaging/ColorPalette.xml

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -70,14 +70,6 @@
7070
<AssemblyName>System.Drawing</AssemblyName>
7171
</AssemblyInfo>
7272
<Parameters>
73-
<Parameter Name="entries" Type="System.Drawing.Color[]" Index="0" FrameworkAlternate="dotnet-plat-ext-9.0">
74-
<Attributes>
75-
<Attribute>
76-
<AttributeName Language="C#">[System.ParamArray]</AttributeName>
77-
<AttributeName Language="F#">[&lt;System.ParamArray&gt;]</AttributeName>
78-
</Attribute>
79-
</Attributes>
80-
</Parameter>
8173
<Parameter Name="customColors" Type="System.Drawing.Color[]" Index="0" FrameworkAlternate="net-9.0;windowsdesktop-9.0">
8274
<Attributes>
8375
<Attribute>
@@ -88,7 +80,6 @@
8880
</Parameter>
8981
</Parameters>
9082
<Docs>
91-
<param name="entries">To be added.</param>
9283
<param name="customColors">Color entries for the palette.</param>
9384
<summary>Creates a custom color palette.</summary>
9485
<remarks>To be added.</remarks>
@@ -110,12 +101,10 @@
110101
<AssemblyName>System.Drawing</AssemblyName>
111102
</AssemblyInfo>
112103
<Parameters>
113-
<Parameter Name="paletteType" Type="System.Drawing.Imaging.PaletteType" Index="0" FrameworkAlternate="dotnet-plat-ext-9.0" />
114104
<Parameter Name="fixedPaletteType" Type="System.Drawing.Imaging.PaletteType" Index="0" FrameworkAlternate="net-9.0;windowsdesktop-9.0" />
115105
</Parameters>
116106
<Docs>
117-
<param name="paletteType">To be added.</param>
118-
<param name="fixedPaletteType">To be added.</param>
107+
<param name="fixedPaletteType">The palette type.</param>
119108
<summary>Creates a standard color palette.</summary>
120109
<remarks>To be added.</remarks>
121110
</Docs>
@@ -145,7 +134,8 @@
145134
</Parameters>
146135
<Docs>
147136
<param name="colors">The number of colors you want to have in an optimal palette based on a the specified bitmap.</param>
148-
<param name="useTransparentColor"><see langword="true"/> to include the transparent color in the palette.</param>
137+
<param name="useTransparentColor">
138+
<see langword="true" /> to include the transparent color in the palette; otherwise, <see langword="false" />.</param>
149139
<param name="bitmap">The bitmap to base the optimal color palette off of.</param>
150140
<summary>Creates an optimal color palette based on the colors in a given bitmap.</summary>
151141
<returns>The optimal color palette for the specified bitmap.</returns>

‎xml/System.Drawing.Imaging/ImageAttributes.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1274,6 +1274,7 @@
12741274
<param name="map">To be added.</param>
12751275
<summary>To be added.</summary>
12761276
<remarks>To be added.</remarks>
1277+
<inheritdoc cref="M:System.Drawing.Imaging.ImageAttributes.SetRemapTable(System.Drawing.Imaging.ColorAdjustType,System.ReadOnlySpan{System.Drawing.Imaging.ColorMap})" />
12771278
</Docs>
12781279
</Member>
12791280
<Member MemberName="SetBrushRemapTable">
@@ -1322,6 +1323,7 @@
13221323
<param name="map">To be added.</param>
13231324
<summary>To be added.</summary>
13241325
<remarks>To be added.</remarks>
1326+
<inheritdoc cref="M:System.Drawing.Imaging.ImageAttributes.SetRemapTable(System.Drawing.Imaging.ColorAdjustType,System.ReadOnlySpan{System.Drawing.Imaging.ColorMap})" />
13251327
</Docs>
13261328
</Member>
13271329
<MemberGroup MemberName="SetColorKey">

‎xml/System.Drawing.Imaging/PixelFormat.xml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@
7575
<MemberValue>262144</MemberValue>
7676
<Docs>
7777
<summary>The pixel data contains alpha values that are not premultiplied.</summary>
78+
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Alpha" />
7879
</Docs>
7980
</Member>
8081
<Member MemberName="Canonical">
@@ -140,6 +141,7 @@
140141
<MemberValue>0</MemberValue>
141142
<Docs>
142143
<summary>No pixel format is specified.</summary>
144+
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.DontCare" />
143145
</Docs>
144146
</Member>
145147
<Member MemberName="Extended">
@@ -205,6 +207,7 @@
205207
<MemberValue>397319</MemberValue>
206208
<Docs>
207209
<summary>The pixel format is 16 bits per pixel. The color information specifies 32,768 shades of color, of which 5 bits are red, 5 bits are green, 5 bits are blue, and 1 bit is alpha.</summary>
210+
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format16bppArgb1555" />
208211
</Docs>
209212
</Member>
210213
<Member MemberName="Format16bppGrayScale">
@@ -270,6 +273,7 @@
270273
<MemberValue>135173</MemberValue>
271274
<Docs>
272275
<summary>Specifies that the format is 16 bits per pixel; 5 bits each are used for the red, green, and blue components. The remaining bit is not used.</summary>
276+
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format16bppRgb555" />
273277
</Docs>
274278
</Member>
275279
<Member MemberName="Format16bppRgb565">
@@ -302,6 +306,7 @@
302306
<MemberValue>135174</MemberValue>
303307
<Docs>
304308
<summary>Specifies that the format is 16 bits per pixel; 5 bits are used for the red component, 6 bits are used for the green component, and 5 bits are used for the blue component.</summary>
309+
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format16bppRgb565" />
305310
</Docs>
306311
</Member>
307312
<Member MemberName="Format1bppIndexed">
@@ -334,6 +339,7 @@
334339
<MemberValue>196865</MemberValue>
335340
<Docs>
336341
<summary>Specifies that the pixel format is 1 bit per pixel and that it uses indexed color. The color table therefore has two colors in it.</summary>
342+
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format1bppIndexed" />
337343
</Docs>
338344
</Member>
339345
<Member MemberName="Format24bppRgb">
@@ -366,6 +372,7 @@
366372
<MemberValue>137224</MemberValue>
367373
<Docs>
368374
<summary>Specifies that the format is 24 bits per pixel; 8 bits each are used for the red, green, and blue components.</summary>
375+
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format24bppRgb" />
369376
</Docs>
370377
</Member>
371378
<Member MemberName="Format32bppArgb">
@@ -398,6 +405,7 @@
398405
<MemberValue>2498570</MemberValue>
399406
<Docs>
400407
<summary>Specifies that the format is 32 bits per pixel; 8 bits each are used for the alpha, red, green, and blue components.</summary>
408+
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format32bppArgb" />
401409
</Docs>
402410
</Member>
403411
<Member MemberName="Format32bppPArgb">
@@ -430,6 +438,7 @@
430438
<MemberValue>925707</MemberValue>
431439
<Docs>
432440
<summary>Specifies that the format is 32 bits per pixel; 8 bits each are used for the alpha, red, green, and blue components. The red, green, and blue components are premultiplied, according to the alpha component.</summary>
441+
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format32bppPArgb" />
433442
</Docs>
434443
</Member>
435444
<Member MemberName="Format32bppRgb">
@@ -462,6 +471,7 @@
462471
<MemberValue>139273</MemberValue>
463472
<Docs>
464473
<summary>Specifies that the format is 32 bits per pixel; 8 bits each are used for the red, green, and blue components. The remaining 8 bits are not used.</summary>
474+
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format32bppRgb" />
465475
</Docs>
466476
</Member>
467477
<Member MemberName="Format48bppRgb">
@@ -494,6 +504,7 @@
494504
<MemberValue>1060876</MemberValue>
495505
<Docs>
496506
<summary>Specifies that the format is 48 bits per pixel; 16 bits each are used for the red, green, and blue components.</summary>
507+
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format48bppRgb" />
497508
</Docs>
498509
</Member>
499510
<Member MemberName="Format4bppIndexed">
@@ -526,6 +537,7 @@
526537
<MemberValue>197634</MemberValue>
527538
<Docs>
528539
<summary>Specifies that the format is 4 bits per pixel, indexed.</summary>
540+
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format4bppIndexed" />
529541
</Docs>
530542
</Member>
531543
<Member MemberName="Format64bppArgb">
@@ -558,6 +570,7 @@
558570
<MemberValue>3424269</MemberValue>
559571
<Docs>
560572
<summary>Specifies that the format is 64 bits per pixel; 16 bits each are used for the alpha, red, green, and blue components.</summary>
573+
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format64bppArgb" />
561574
</Docs>
562575
</Member>
563576
<Member MemberName="Format64bppPArgb">
@@ -590,6 +603,7 @@
590603
<MemberValue>1851406</MemberValue>
591604
<Docs>
592605
<summary>Specifies that the format is 64 bits per pixel; 16 bits each are used for the alpha, red, green, and blue components. The red, green, and blue components are premultiplied according to the alpha component.</summary>
606+
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format64bppPArgb" />
593607
</Docs>
594608
</Member>
595609
<Member MemberName="Format8bppIndexed">
@@ -622,6 +636,7 @@
622636
<MemberValue>198659</MemberValue>
623637
<Docs>
624638
<summary>Specifies that the format is 8 bits per pixel, indexed. The color table therefore has 256 colors in it.</summary>
639+
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format8bppIndexed" />
625640
</Docs>
626641
</Member>
627642
<Member MemberName="Gdi">
@@ -654,6 +669,7 @@
654669
<MemberValue>131072</MemberValue>
655670
<Docs>
656671
<summary>The pixel data contains GDI colors.</summary>
672+
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Gdi" />
657673
</Docs>
658674
</Member>
659675
<Member MemberName="Indexed">
@@ -686,6 +702,7 @@
686702
<MemberValue>65536</MemberValue>
687703
<Docs>
688704
<summary>The pixel data contains color-indexed values, which means the values are an index to colors in the system color table, as opposed to individual color values.</summary>
705+
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Indexed" />
689706
</Docs>
690707
</Member>
691708
<Member MemberName="Max">
@@ -718,6 +735,7 @@
718735
<MemberValue>15</MemberValue>
719736
<Docs>
720737
<summary>The maximum value for this enumeration.</summary>
738+
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Max" />
721739
</Docs>
722740
</Member>
723741
<Member MemberName="PAlpha">
@@ -750,6 +768,7 @@
750768
<MemberValue>524288</MemberValue>
751769
<Docs>
752770
<summary>The pixel format contains premultiplied alpha values.</summary>
771+
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.PAlpha" />
753772
</Docs>
754773
</Member>
755774
<Member MemberName="Undefined">
@@ -782,6 +801,7 @@
782801
<MemberValue>0</MemberValue>
783802
<Docs>
784803
<summary>The pixel format is undefined.</summary>
804+
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Undefined" />
785805
</Docs>
786806
</Member>
787807
</Members>

0 commit comments

Comments
 (0)