From 54385ee8dc35217cdef85815b6cc99ce75453f40 Mon Sep 17 00:00:00 2001 From: Kevin Gallahan Date: Sat, 21 Oct 2023 08:48:01 -0400 Subject: [PATCH 1/2] Update AlphaOption.cs xml docs This copies over the descriptions from the official docs. --- src/Magick.NET.Core/Enums/AlphaOption.cs | 38 ++++++++++++++++-------- 1 file changed, 26 insertions(+), 12 deletions(-) diff --git a/src/Magick.NET.Core/Enums/AlphaOption.cs b/src/Magick.NET.Core/Enums/AlphaOption.cs index 418c95582c..5261548145 100644 --- a/src/Magick.NET.Core/Enums/AlphaOption.cs +++ b/src/Magick.NET.Core/Enums/AlphaOption.cs @@ -14,27 +14,34 @@ public enum AlphaOption Undefined, /// - /// Activate. + /// Enable the image's transparency channel. Note that normally Set should be used instead of + /// this, unless you specifically need to preserve the existing (but specifically turned Off) + /// transparency channel. /// Activate, /// - /// Associate. + /// Associate the alpha channel with the image. /// Associate, /// - /// Background. + /// Set any fully-transparent pixel to the background color, while leaving it fully-transparent. + /// This can make some image file formats, such as PNG, smaller as the RGB values of transparent + /// pixels are more uniform, and thus can compress better. /// Background, /// - /// Copy. + /// Turns 'On' the alpha/matte channel, then copies the grayscale intensity of the image, into + /// the alpha channel, converting a grayscale mask into a transparent shaped mask ready to be + /// colored appropriately. The color channels are not modified. /// Copy, /// - /// Deactivate. + /// Disables the image's transparency channel. This does not delete or change the existing data, + /// it just turns off the use of that data. /// Deactivate, @@ -44,12 +51,14 @@ public enum AlphaOption Discrete, /// - /// Disassociate. + /// Disassociate the alpha channel from the image. /// Disassociate, /// - /// Extract. + /// Copies the alpha channel values into all the color channels and turns 'Off' the image's + /// transparency, so as to generate a grayscale mask of the image's shape. The alpha channel + /// data is left intact just deactivated. This is the inverse of 'Copy'. /// Extract, @@ -64,27 +73,32 @@ public enum AlphaOption On, /// - /// Opaque. + /// Enables the alpha/matte channel and forces it to be fully opaque. /// Opaque, /// - /// Remove. + /// Composite the image over the background color. /// Remove, /// - /// Set. + /// Activates the alpha/matte channel. If it was previously turned off then it also + /// resets the channel to opaque. If the image already had the alpha channel turned on, + /// it will have no effect. /// Set, /// - /// Shape. + /// As per 'Copy' but also colors the resulting shape mask with the current background color. + /// That is the RGB color channels is replaced, with appropriate alpha shape. /// Shape, /// - /// Transparent. + /// Activates the alpha/matte channel and forces it to be fully transparent. This effectively + /// creates a fully transparent image the same size as the original and with all its original + /// RGB data still intact, but fully transparent. /// Transparent, } From 963eb03ad69fad290fbadbb1637f14c0ba5fa561 Mon Sep 17 00:00:00 2001 From: Kevin Gallahan Date: Sat, 21 Oct 2023 10:20:43 -0400 Subject: [PATCH 2/2] Whitespace --- src/Magick.NET.Core/Enums/AlphaOption.cs | 28 ++++++++++++------------ 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/src/Magick.NET.Core/Enums/AlphaOption.cs b/src/Magick.NET.Core/Enums/AlphaOption.cs index 5261548145..b2e61b1de2 100644 --- a/src/Magick.NET.Core/Enums/AlphaOption.cs +++ b/src/Magick.NET.Core/Enums/AlphaOption.cs @@ -14,8 +14,8 @@ public enum AlphaOption Undefined, /// - /// Enable the image's transparency channel. Note that normally Set should be used instead of - /// this, unless you specifically need to preserve the existing (but specifically turned Off) + /// Enable the image's transparency channel. Note that normally Set should be used instead of + /// this, unless you specifically need to preserve the existing (but specifically turned Off) /// transparency channel. /// Activate, @@ -26,21 +26,21 @@ public enum AlphaOption Associate, /// - /// Set any fully-transparent pixel to the background color, while leaving it fully-transparent. - /// This can make some image file formats, such as PNG, smaller as the RGB values of transparent + /// Set any fully-transparent pixel to the background color, while leaving it fully-transparent. + /// This can make some image file formats, such as PNG, smaller as the RGB values of transparent /// pixels are more uniform, and thus can compress better. /// Background, /// - /// Turns 'On' the alpha/matte channel, then copies the grayscale intensity of the image, into - /// the alpha channel, converting a grayscale mask into a transparent shaped mask ready to be + /// Turns 'On' the alpha/matte channel, then copies the grayscale intensity of the image, into + /// the alpha channel, converting a grayscale mask into a transparent shaped mask ready to be /// colored appropriately. The color channels are not modified. /// Copy, /// - /// Disables the image's transparency channel. This does not delete or change the existing data, + /// Disables the image's transparency channel. This does not delete or change the existing data, /// it just turns off the use of that data. /// Deactivate, @@ -56,8 +56,8 @@ public enum AlphaOption Disassociate, /// - /// Copies the alpha channel values into all the color channels and turns 'Off' the image's - /// transparency, so as to generate a grayscale mask of the image's shape. The alpha channel + /// Copies the alpha channel values into all the color channels and turns 'Off' the image's + /// transparency, so as to generate a grayscale mask of the image's shape. The alpha channel /// data is left intact just deactivated. This is the inverse of 'Copy'. /// Extract, @@ -83,21 +83,21 @@ public enum AlphaOption Remove, /// - /// Activates the alpha/matte channel. If it was previously turned off then it also - /// resets the channel to opaque. If the image already had the alpha channel turned on, + /// Activates the alpha/matte channel. If it was previously turned off then it also + /// resets the channel to opaque. If the image already had the alpha channel turned on, /// it will have no effect. /// Set, /// - /// As per 'Copy' but also colors the resulting shape mask with the current background color. + /// As per 'Copy' but also colors the resulting shape mask with the current background color. /// That is the RGB color channels is replaced, with appropriate alpha shape. /// Shape, /// - /// Activates the alpha/matte channel and forces it to be fully transparent. This effectively - /// creates a fully transparent image the same size as the original and with all its original + /// Activates the alpha/matte channel and forces it to be fully transparent. This effectively + /// creates a fully transparent image the same size as the original and with all its original /// RGB data still intact, but fully transparent. /// Transparent,