From 6464d494019c6a6015d5a3d65632296837d55c5e Mon Sep 17 00:00:00 2001 From: Loni Tra Date: Fri, 6 Sep 2024 15:25:57 -0700 Subject: [PATCH 1/3] Add remaining missing documentation --- xml/System.Drawing.Drawing2D/GraphicsPath.xml | 1 + xml/System.Drawing.Drawing2D/Matrix.xml | 1 + .../PathGradientBrush.xml | 2 +- .../BlurEffect.xml | 6 +++-- xml/System.Drawing.Imaging.Effects/Effect.xml | 10 ++++---- .../GrayScaleEffect.xml | 2 +- .../InvertEffect.xml | 2 +- .../SepiaEffect.xml | 2 +- .../VividEffect.xml | 2 +- xml/System.Drawing.Imaging/ColorMatrix.xml | 2 +- xml/System.Drawing.Imaging/ColorPalette.xml | 17 ++++---------- .../ImageAttributes.xml | 2 ++ xml/System.Drawing.Imaging/PixelFormat.xml | 20 ++++++++++++++++ xml/System.Drawing/Graphics.xml | 23 +++++++++++++++++-- 14 files changed, 64 insertions(+), 28 deletions(-) diff --git a/xml/System.Drawing.Drawing2D/GraphicsPath.xml b/xml/System.Drawing.Drawing2D/GraphicsPath.xml index d46ff629690..6bfbf8d9bba 100644 --- a/xml/System.Drawing.Drawing2D/GraphicsPath.xml +++ b/xml/System.Drawing.Drawing2D/GraphicsPath.xml @@ -1650,6 +1650,7 @@ ]]> + diff --git a/xml/System.Drawing.Drawing2D/Matrix.xml b/xml/System.Drawing.Drawing2D/Matrix.xml index da844464444..839022d04b6 100644 --- a/xml/System.Drawing.Drawing2D/Matrix.xml +++ b/xml/System.Drawing.Drawing2D/Matrix.xml @@ -1647,6 +1647,7 @@ Matrix myMatrix = new Matrix(3, 5, 1, 2, 2, 4); To be added. To be added. To be added. + diff --git a/xml/System.Drawing.Drawing2D/PathGradientBrush.xml b/xml/System.Drawing.Drawing2D/PathGradientBrush.xml index 185826d8a9c..d9158f0a608 100644 --- a/xml/System.Drawing.Drawing2D/PathGradientBrush.xml +++ b/xml/System.Drawing.Drawing2D/PathGradientBrush.xml @@ -373,7 +373,7 @@ To be added. To be added. To be added. - + diff --git a/xml/System.Drawing.Imaging.Effects/BlurEffect.xml b/xml/System.Drawing.Imaging.Effects/BlurEffect.xml index fd29ad3bab9..cdd45e9ded2 100644 --- a/xml/System.Drawing.Imaging.Effects/BlurEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/BlurEffect.xml @@ -36,9 +36,11 @@ - to expand the bitmap by an amount equal to the blur radius so it can have soft edges. to keep the bitmap the same size and clip the soft edges. - + + + Boolean value that specifies whether the bitmap expands by an amount equal to the blur radius. If , the bitmap expands by an amount equal to the radius so that it can have soft edges. + If , the bitmap remains the same size and the soft edges are clipped. Creates a new with the given parameters. To be added. diff --git a/xml/System.Drawing.Imaging.Effects/Effect.xml b/xml/System.Drawing.Imaging.Effects/Effect.xml index 12ab86fe0b3..a7e56650b63 100644 --- a/xml/System.Drawing.Imaging.Effects/Effect.xml +++ b/xml/System.Drawing.Imaging.Effects/Effect.xml @@ -47,12 +47,12 @@ - - + + - + - + Method System.Drawing.Common @@ -87,7 +87,7 @@ - To be added. + Cleans up Windows resources for this To be added. diff --git a/xml/System.Drawing.Imaging.Effects/GrayScaleEffect.xml b/xml/System.Drawing.Imaging.Effects/GrayScaleEffect.xml index e531ae4c18c..f526b2527b7 100644 --- a/xml/System.Drawing.Imaging.Effects/GrayScaleEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/GrayScaleEffect.xml @@ -31,7 +31,7 @@ - To be added. + Creates a that converts an image to grayscale. To be added. diff --git a/xml/System.Drawing.Imaging.Effects/InvertEffect.xml b/xml/System.Drawing.Imaging.Effects/InvertEffect.xml index 5c75cf730a4..c1797efcc2d 100644 --- a/xml/System.Drawing.Imaging.Effects/InvertEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/InvertEffect.xml @@ -31,7 +31,7 @@ - To be added. + Creates a that inverts the colors in an image. To be added. diff --git a/xml/System.Drawing.Imaging.Effects/SepiaEffect.xml b/xml/System.Drawing.Imaging.Effects/SepiaEffect.xml index 0c30c4b5923..5936378a7a1 100644 --- a/xml/System.Drawing.Imaging.Effects/SepiaEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/SepiaEffect.xml @@ -31,7 +31,7 @@ - To be added. + Creates a new that converts an image to sepia. To be added. diff --git a/xml/System.Drawing.Imaging.Effects/VividEffect.xml b/xml/System.Drawing.Imaging.Effects/VividEffect.xml index a372cfbf746..d512ac8c45f 100644 --- a/xml/System.Drawing.Imaging.Effects/VividEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/VividEffect.xml @@ -31,7 +31,7 @@ - To be added. + Creates a new that makes colors more vivid. To be added. diff --git a/xml/System.Drawing.Imaging/ColorMatrix.xml b/xml/System.Drawing.Imaging/ColorMatrix.xml index c067005f0c9..2162a8642c6 100644 --- a/xml/System.Drawing.Imaging/ColorMatrix.xml +++ b/xml/System.Drawing.Imaging/ColorMatrix.xml @@ -162,7 +162,7 @@ - To be added. + The values of the elements of the new matrix. Initializes a new instance of the class with the elements in the specified matrix. To be added. diff --git a/xml/System.Drawing.Imaging/ColorPalette.xml b/xml/System.Drawing.Imaging/ColorPalette.xml index 01e98225252..97b31e15be6 100644 --- a/xml/System.Drawing.Imaging/ColorPalette.xml +++ b/xml/System.Drawing.Imaging/ColorPalette.xml @@ -70,14 +70,6 @@ System.Drawing - - - - [System.ParamArray] - [<System.ParamArray>] - - - @@ -88,7 +80,6 @@ - To be added. Color entries for the palette. Creates a custom color palette. To be added. @@ -110,12 +101,10 @@ System.Drawing - - To be added. - To be added. + The palette type. Creates a standard color palette. To be added. @@ -145,11 +134,13 @@ The number of colors you want to have in an optimal palette based on a the specified bitmap. - to include the transparent color in the palette. + + to include the transparent color in the palette. The bitmap to base the optimal color palette off of. Creates an optimal color palette based on the colors in a given bitmap. The optimal color palette for the specified bitmap. To be added. + diff --git a/xml/System.Drawing.Imaging/ImageAttributes.xml b/xml/System.Drawing.Imaging/ImageAttributes.xml index 7a0ee61b831..733bbf32243 100644 --- a/xml/System.Drawing.Imaging/ImageAttributes.xml +++ b/xml/System.Drawing.Imaging/ImageAttributes.xml @@ -1274,6 +1274,7 @@ To be added. To be added. To be added. + @@ -1322,6 +1323,7 @@ To be added. To be added. To be added. + diff --git a/xml/System.Drawing.Imaging/PixelFormat.xml b/xml/System.Drawing.Imaging/PixelFormat.xml index 5c15c9073b6..af63c63c8e2 100644 --- a/xml/System.Drawing.Imaging/PixelFormat.xml +++ b/xml/System.Drawing.Imaging/PixelFormat.xml @@ -75,6 +75,7 @@ 262144 The pixel data contains alpha values that are not premultiplied. + @@ -140,6 +141,7 @@ 0 No pixel format is specified. + @@ -205,6 +207,7 @@ 397319 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. + @@ -270,6 +273,7 @@ 135173 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. + @@ -302,6 +306,7 @@ 135174 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. + @@ -334,6 +339,7 @@ 196865 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. + @@ -366,6 +372,7 @@ 137224 Specifies that the format is 24 bits per pixel; 8 bits each are used for the red, green, and blue components. + @@ -398,6 +405,7 @@ 2498570 Specifies that the format is 32 bits per pixel; 8 bits each are used for the alpha, red, green, and blue components. + @@ -430,6 +438,7 @@ 925707 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. + @@ -462,6 +471,7 @@ 139273 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. + @@ -494,6 +504,7 @@ 1060876 Specifies that the format is 48 bits per pixel; 16 bits each are used for the red, green, and blue components. + @@ -526,6 +537,7 @@ 197634 Specifies that the format is 4 bits per pixel, indexed. + @@ -558,6 +570,7 @@ 3424269 Specifies that the format is 64 bits per pixel; 16 bits each are used for the alpha, red, green, and blue components. + @@ -590,6 +603,7 @@ 1851406 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. + @@ -622,6 +636,7 @@ 198659 Specifies that the format is 8 bits per pixel, indexed. The color table therefore has 256 colors in it. + @@ -654,6 +669,7 @@ 131072 The pixel data contains GDI colors. + @@ -686,6 +702,7 @@ 65536 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. + @@ -718,6 +735,7 @@ 15 The maximum value for this enumeration. + @@ -750,6 +768,7 @@ 524288 The pixel format contains premultiplied alpha values. + @@ -782,6 +801,7 @@ 0 The pixel format is undefined. + diff --git a/xml/System.Drawing/Graphics.xml b/xml/System.Drawing/Graphics.xml index 9f8a5e35752..4aa1464eb69 100644 --- a/xml/System.Drawing/Graphics.xml +++ b/xml/System.Drawing/Graphics.xml @@ -1772,6 +1772,7 @@ The number of points in the array should be a multiple of 3 plus 1 because the f -or- is . + @@ -2016,6 +2017,7 @@ The object has a transform applied othe -or- is . + @@ -2101,6 +2103,7 @@ The object has a transform applied othe -or- is . + @@ -2290,6 +2293,7 @@ The object has a transform applied othe -or- is . + @@ -2559,6 +2563,7 @@ The object has a transform applied othe -or- is . + @@ -2644,6 +2649,7 @@ The object has a transform applied othe -or- is . + @@ -2831,6 +2837,7 @@ The object has a transform applied othe -or- is . + @@ -2910,6 +2917,7 @@ The object has a transform applied othe -or- is . + @@ -3317,6 +3325,7 @@ The object has a transform applied othe -or- is . + @@ -7372,6 +7381,7 @@ The object has a transform applied othe -or- is . + @@ -8014,6 +8024,7 @@ The object has a transform applied othe -or- is . + @@ -8518,6 +8529,7 @@ The object has a transform applied othe is . is a zero-length array. + @@ -8685,8 +8697,8 @@ The object has a transform applied othe The to draw the outline with. - To be added. - To be added. + The bounds of the rounded rectangle. + The radius width and height used to round the corners of the rectangle. Draws the outline of the specified rounded rectangle. To be added. @@ -12321,6 +12333,7 @@ The object has a transform applied othe -or- is . + @@ -12404,6 +12417,7 @@ The object has a transform applied othe -or- is . + @@ -12679,6 +12693,7 @@ The object has a transform applied othe -or- is . + @@ -13718,6 +13733,7 @@ The object has a transform applied othe -or- is . + @@ -13801,6 +13817,7 @@ The object has a transform applied othe -or- is . + @@ -14051,6 +14068,7 @@ The object has a transform applied othe -or- is . + @@ -14499,6 +14517,7 @@ The object has a transform applied othe is . is a zero-length array. + From c4336be83faf6d32fd46843aee1e2980373da3c8 Mon Sep 17 00:00:00 2001 From: Loni Tra Date: Fri, 6 Sep 2024 17:19:36 -0700 Subject: [PATCH 2/3] revert inheritdoc change referencing internal method --- xml/System.Drawing.Imaging/ColorPalette.xml | 1 - 1 file changed, 1 deletion(-) diff --git a/xml/System.Drawing.Imaging/ColorPalette.xml b/xml/System.Drawing.Imaging/ColorPalette.xml index 97b31e15be6..329c9f5ce8d 100644 --- a/xml/System.Drawing.Imaging/ColorPalette.xml +++ b/xml/System.Drawing.Imaging/ColorPalette.xml @@ -140,7 +140,6 @@ Creates an optimal color palette based on the colors in a given bitmap. The optimal color palette for the specified bitmap. To be added. - From cfe6a8b3bec03e9e8b72d7d00db68bcdcc7b7205 Mon Sep 17 00:00:00 2001 From: Loni Tra Date: Mon, 9 Sep 2024 14:25:02 -0700 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> --- xml/System.Drawing.Imaging.Effects/BlurEffect.xml | 8 ++++---- xml/System.Drawing.Imaging.Effects/Effect.xml | 2 +- xml/System.Drawing.Imaging/ColorPalette.xml | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/xml/System.Drawing.Imaging.Effects/BlurEffect.xml b/xml/System.Drawing.Imaging.Effects/BlurEffect.xml index cdd45e9ded2..403b67263e6 100644 --- a/xml/System.Drawing.Imaging.Effects/BlurEffect.xml +++ b/xml/System.Drawing.Imaging.Effects/BlurEffect.xml @@ -36,13 +36,13 @@ - to expand the bitmap by an amount equal to the blur radius so it can have soft edges. to keep the bitmap the same size and clip the soft edges. + Real number that specifies the blur radius (the radius of the Gaussian convolution kernel) in pixels. The + radius must be in the range 0 through 256. As the radius increases, the resulting bitmap becomes more blurry. - Boolean value that specifies whether the bitmap expands by an amount equal to the blur radius. If , the bitmap expands by an amount equal to the radius so that it can have soft edges. - If , the bitmap remains the same size and the soft edges are clipped. + to expand the bitmap by an amount equal to the blur radius so that it can have soft edges; to keep the bitmap the same size and clip the soft edges. - Creates a new with the given parameters. + Creates a new with the specified blur radius. To be added. is less than 0 or greater than 256. diff --git a/xml/System.Drawing.Imaging.Effects/Effect.xml b/xml/System.Drawing.Imaging.Effects/Effect.xml index a7e56650b63..00bf52f1fad 100644 --- a/xml/System.Drawing.Imaging.Effects/Effect.xml +++ b/xml/System.Drawing.Imaging.Effects/Effect.xml @@ -87,7 +87,7 @@ - Cleans up Windows resources for this + Cleans up Windows resources for this . To be added. diff --git a/xml/System.Drawing.Imaging/ColorPalette.xml b/xml/System.Drawing.Imaging/ColorPalette.xml index 329c9f5ce8d..6aeaa1064ec 100644 --- a/xml/System.Drawing.Imaging/ColorPalette.xml +++ b/xml/System.Drawing.Imaging/ColorPalette.xml @@ -135,7 +135,7 @@ The number of colors you want to have in an optimal palette based on a the specified bitmap. - to include the transparent color in the palette. + to include the transparent color in the palette; otherwise, . The bitmap to base the optimal color palette off of. Creates an optimal color palette based on the colors in a given bitmap. The optimal color palette for the specified bitmap.