Skip to content

Add Remaining Documentation for System.Drawing for .NET 9 #10372

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 3 commits into from
Sep 9, 2024
Merged

Add Remaining Documentation for System.Drawing for .NET 9 #10372

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6464d49
Add remaining missing documentation
lonitra Sep 6, 2024
c4336be
revert inheritdoc change referencing internal method
lonitra Sep 7, 2024
cfe6a8b
Apply suggestions from code review
lonitra Sep 9, 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
1 change: 1 addition & 0 deletions xml/System.Drawing.Drawing2D/GraphicsPath.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1650,6 +1650,7 @@

]]></format>
</remarks>
<inheritdoc cref="M:System.Drawing.Drawing2D.GraphicsPath.AddCurve(System.Drawing.PointF[],System.Int32,System.Int32,System.Single)" />
</Docs>
</Member>
<Member MemberName="AddCurve">
Expand Down
1 change: 1 addition & 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 @@ -1647,6 +1647,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>
<MemberGroup MemberName="TransformVectors">
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Drawing.Drawing2D/PathGradientBrush.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +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[])" />
<inheritdoc cref="M:System.Drawing.Drawing2D.PathGradientBrush.#ctor(System.Drawing.PointF[],System.Drawing.Drawing2D.WrapMode)" />
</Docs>
</Member>
<Member MemberName=".ctor">
Expand Down
6 changes: 4 additions & 2 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 @@ -36,9 +36,11 @@
</Parameters>
<Docs>
<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>
<param name="expandEdge">
Boolean value that specifies whether the bitmap expands by an amount equal to the blur radius. If <see langword="true"/>, the bitmap expands by an amount equal to the radius so that it can have soft edges.
If <see langword="false"/>, the bitmap remains the same size and the soft edges are clipped.
</param>
<summary>Creates a new <see cref="T:System.Drawing.Imaging.Effects.BlurEffect" /> with the given parameters.</summary>
<remarks>To be added.</remarks>
Expand Down
10 changes: 5 additions & 5 deletions xml/System.Drawing.Imaging.Effects/Effect.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,12 @@
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public virtual void Dispose (bool disposing);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
<MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
<MemberSignature Language="ILAsm" Value=".method protected hidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Drawing.Imaging.Effects.Effect.Dispose(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub Dispose (disposing As Boolean)" />
<MemberSignature Language="VB.NET" Value="protected Overridable Sub Dispose (disposing As Boolean)" />
<MemberSignature Language="F#" Value="abstract member Dispose : bool -&gt; unit&#xA;override this.Dispose : bool -&gt; unit" Usage="effect.Dispose disposing" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; virtual void Dispose(bool disposing);" />
<MemberSignature Language="C++ CLI" Value="protected:&#xA; virtual void Dispose(bool disposing);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Drawing.Common</AssemblyName>
Expand Down Expand Up @@ -87,7 +87,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Cleans up Windows resources for this <see cref="T:System.Drawing.Imaging.Effects.Effect" /></summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Drawing.Imaging.Effects/GrayScaleEffect.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Creates a <see cref="T:System.Drawing.Imaging.Effects.ColorMatrixEffect" /> that converts an image to grayscale.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Drawing.Imaging.Effects/InvertEffect.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Creates a <see cref="T:System.Drawing.Imaging.Effects.ColorMatrixEffect" /> that inverts the colors in an image.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Drawing.Imaging.Effects/SepiaEffect.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Creates a new <see cref="T:System.Drawing.Imaging.Effects.ColorMatrixEffect" /> that converts an image to sepia.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Drawing.Imaging.Effects/VividEffect.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Creates a new <see cref="T:System.Drawing.Imaging.Effects.ColorMatrixEffect" /> that makes colors more vivid.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Drawing.Imaging/ColorMatrix.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@
</Parameter>
</Parameters>
<Docs>
<param name="newColorMatrix">To be added.</param>
<param name="newColorMatrix">The values of the elements of the new matrix.</param>
<summary>Initializes a new instance of the <see cref="T:System.Drawing.Imaging.ColorMatrix" /> class with the elements in the specified matrix.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
Expand Down
16 changes: 3 additions & 13 deletions xml/System.Drawing.Imaging/ColorPalette.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,14 +70,6 @@
<AssemblyName>System.Drawing</AssemblyName>
</AssemblyInfo>
<Parameters>
<Parameter Name="entries" Type="System.Drawing.Color[]" Index="0" FrameworkAlternate="dotnet-plat-ext-9.0">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ParamArray]</AttributeName>
<AttributeName Language="F#">[&lt;System.ParamArray&gt;]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<Parameter Name="customColors" Type="System.Drawing.Color[]" Index="0" FrameworkAlternate="net-9.0;windowsdesktop-9.0">
<Attributes>
<Attribute>
Expand All @@ -88,7 +80,6 @@
</Parameter>
</Parameters>
<Docs>
<param name="entries">To be added.</param>
<param name="customColors">Color entries for the palette.</param>
<summary>Creates a custom color palette.</summary>
<remarks>To be added.</remarks>
Expand All @@ -110,12 +101,10 @@
<AssemblyName>System.Drawing</AssemblyName>
</AssemblyInfo>
<Parameters>
<Parameter Name="paletteType" Type="System.Drawing.Imaging.PaletteType" Index="0" FrameworkAlternate="dotnet-plat-ext-9.0" />
<Parameter Name="fixedPaletteType" Type="System.Drawing.Imaging.PaletteType" Index="0" FrameworkAlternate="net-9.0;windowsdesktop-9.0" />
</Parameters>
<Docs>
<param name="paletteType">To be added.</param>
<param name="fixedPaletteType">To be added.</param>
<param name="fixedPaletteType">The palette type.</param>
<summary>Creates a standard color palette.</summary>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -145,7 +134,8 @@
</Parameters>
<Docs>
<param name="colors">The number of colors you want to have in an optimal palette based on a the specified bitmap.</param>
<param name="useTransparentColor"><see langword="true"/> to include the transparent color in the palette.</param>
<param name="useTransparentColor">
<see langword="true" /> to include the transparent color in the palette.</param>
<param name="bitmap">The bitmap to base the optimal color palette off of.</param>
<summary>Creates an optimal color palette based on the colors in a given bitmap.</summary>
<returns>The optimal color palette for the specified bitmap.</returns>
Expand Down
2 changes: 2 additions & 0 deletions xml/System.Drawing.Imaging/ImageAttributes.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1274,6 +1274,7 @@
<param name="map">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Drawing.Imaging.ImageAttributes.SetRemapTable(System.Drawing.Imaging.ColorAdjustType,System.ReadOnlySpan{System.Drawing.Imaging.ColorMap})" />
</Docs>
</Member>
<Member MemberName="SetBrushRemapTable">
Expand Down Expand Up @@ -1322,6 +1323,7 @@
<param name="map">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Drawing.Imaging.ImageAttributes.SetRemapTable(System.Drawing.Imaging.ColorAdjustType,System.ReadOnlySpan{System.Drawing.Imaging.ColorMap})" />
</Docs>
</Member>
<MemberGroup MemberName="SetColorKey">
Expand Down
20 changes: 20 additions & 0 deletions xml/System.Drawing.Imaging/PixelFormat.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@
<MemberValue>262144</MemberValue>
<Docs>
<summary>The pixel data contains alpha values that are not premultiplied.</summary>
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Alpha" />
</Docs>
</Member>
<Member MemberName="Canonical">
Expand Down Expand Up @@ -140,6 +141,7 @@
<MemberValue>0</MemberValue>
<Docs>
<summary>No pixel format is specified.</summary>
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.DontCare" />
</Docs>
</Member>
<Member MemberName="Extended">
Expand Down Expand Up @@ -205,6 +207,7 @@
<MemberValue>397319</MemberValue>
<Docs>
<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>
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format16bppArgb1555" />
</Docs>
</Member>
<Member MemberName="Format16bppGrayScale">
Expand Down Expand Up @@ -270,6 +273,7 @@
<MemberValue>135173</MemberValue>
<Docs>
<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>
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format16bppRgb555" />
</Docs>
</Member>
<Member MemberName="Format16bppRgb565">
Expand Down Expand Up @@ -302,6 +306,7 @@
<MemberValue>135174</MemberValue>
<Docs>
<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>
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format16bppRgb565" />
</Docs>
</Member>
<Member MemberName="Format1bppIndexed">
Expand Down Expand Up @@ -334,6 +339,7 @@
<MemberValue>196865</MemberValue>
<Docs>
<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>
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format1bppIndexed" />
</Docs>
</Member>
<Member MemberName="Format24bppRgb">
Expand Down Expand Up @@ -366,6 +372,7 @@
<MemberValue>137224</MemberValue>
<Docs>
<summary>Specifies that the format is 24 bits per pixel; 8 bits each are used for the red, green, and blue components.</summary>
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format24bppRgb" />
</Docs>
</Member>
<Member MemberName="Format32bppArgb">
Expand Down Expand Up @@ -398,6 +405,7 @@
<MemberValue>2498570</MemberValue>
<Docs>
<summary>Specifies that the format is 32 bits per pixel; 8 bits each are used for the alpha, red, green, and blue components.</summary>
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format32bppArgb" />
</Docs>
</Member>
<Member MemberName="Format32bppPArgb">
Expand Down Expand Up @@ -430,6 +438,7 @@
<MemberValue>925707</MemberValue>
<Docs>
<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>
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format32bppPArgb" />
</Docs>
</Member>
<Member MemberName="Format32bppRgb">
Expand Down Expand Up @@ -462,6 +471,7 @@
<MemberValue>139273</MemberValue>
<Docs>
<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>
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format32bppRgb" />
</Docs>
</Member>
<Member MemberName="Format48bppRgb">
Expand Down Expand Up @@ -494,6 +504,7 @@
<MemberValue>1060876</MemberValue>
<Docs>
<summary>Specifies that the format is 48 bits per pixel; 16 bits each are used for the red, green, and blue components.</summary>
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format48bppRgb" />
</Docs>
</Member>
<Member MemberName="Format4bppIndexed">
Expand Down Expand Up @@ -526,6 +537,7 @@
<MemberValue>197634</MemberValue>
<Docs>
<summary>Specifies that the format is 4 bits per pixel, indexed.</summary>
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format4bppIndexed" />
</Docs>
</Member>
<Member MemberName="Format64bppArgb">
Expand Down Expand Up @@ -558,6 +570,7 @@
<MemberValue>3424269</MemberValue>
<Docs>
<summary>Specifies that the format is 64 bits per pixel; 16 bits each are used for the alpha, red, green, and blue components.</summary>
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format64bppArgb" />
</Docs>
</Member>
<Member MemberName="Format64bppPArgb">
Expand Down Expand Up @@ -590,6 +603,7 @@
<MemberValue>1851406</MemberValue>
<Docs>
<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>
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format64bppPArgb" />
</Docs>
</Member>
<Member MemberName="Format8bppIndexed">
Expand Down Expand Up @@ -622,6 +636,7 @@
<MemberValue>198659</MemberValue>
<Docs>
<summary>Specifies that the format is 8 bits per pixel, indexed. The color table therefore has 256 colors in it.</summary>
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Format8bppIndexed" />
</Docs>
</Member>
<Member MemberName="Gdi">
Expand Down Expand Up @@ -654,6 +669,7 @@
<MemberValue>131072</MemberValue>
<Docs>
<summary>The pixel data contains GDI colors.</summary>
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Gdi" />
</Docs>
</Member>
<Member MemberName="Indexed">
Expand Down Expand Up @@ -686,6 +702,7 @@
<MemberValue>65536</MemberValue>
<Docs>
<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>
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Indexed" />
</Docs>
</Member>
<Member MemberName="Max">
Expand Down Expand Up @@ -718,6 +735,7 @@
<MemberValue>15</MemberValue>
<Docs>
<summary>The maximum value for this enumeration.</summary>
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Max" />
</Docs>
</Member>
<Member MemberName="PAlpha">
Expand Down Expand Up @@ -750,6 +768,7 @@
<MemberValue>524288</MemberValue>
<Docs>
<summary>The pixel format contains premultiplied alpha values.</summary>
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.PAlpha" />
</Docs>
</Member>
<Member MemberName="Undefined">
Expand Down Expand Up @@ -782,6 +801,7 @@
<MemberValue>0</MemberValue>
<Docs>
<summary>The pixel format is undefined.</summary>
<inheritdoc cref="F:Windows.Win32.Graphics.GdiPlus.PixelFormat.Undefined" />
</Docs>
</Member>
</Members>
Expand Down
Loading