Skip to content

Add XML documentation for compareMetadata parameter #78

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

Closed
Copilot wants to merge 3 commits into from
Closed

Add XML documentation for compareMetadata parameter #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7c4b75c
Initial plan
Copilot Nov 30, 2025
6bbe3d9
Add proper XML documentation for compareMetadata parameter
Copilot Nov 30, 2025
e93d351
Add XML documentation for compareMetadata in ImageCompare constructor
Copilot Nov 30, 2025
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
2 changes: 1 addition & 1 deletion SkiaSharpCompare/ImageCompare.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public class ImageCompare
/// cref="TransparencyOptions.CompareAlphaChannel"/>.</param>
/// <param name="pixelColorShiftTolerance">Specifies the tolerance for color shifts in pixel values during comparison. A value of 0 means no
/// tolerance, and higher values allow for greater differences. The default is 0.</param>
/// <param name="compareMetadata"></param>
/// <param name="compareMetadata">If true, compares image metadata (EXIF, etc.) in addition to pixel data.</param>
public ImageCompare(ResizeOption resizeOption = ResizeOption.DontResize, TransparencyOptions transparencyOptions = TransparencyOptions.CompareAlphaChannel, int pixelColorShiftTolerance = 0, bool compareMetadata = false)
{
ResizeOption = resizeOption;
Expand Down
6 changes: 3 additions & 3 deletions SkiaSharpCompare/SkiaSharpCompare.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ public static bool ImagesHaveEqualSize(SKBitmap actualImage, SKBitmap expectedIm
/// <param name="resizeOption"></param>
/// <param name="pixelColorShiftTolerance"></param>
/// <param name="transparencyOptions"></param>
/// <param name="compareMetadata"></param>
/// <param name="compareMetadata">If true, compares image metadata (EXIF, etc.) in addition to pixel data.</param>
/// <returns>True if every pixel of actual is equal to expected</returns>
public static bool ImagesAreEqual(string pathImageActual, string pathImageExpected, ResizeOption resizeOption = ResizeOption.DontResize, int pixelColorShiftTolerance = 0, TransparencyOptions transparencyOptions = TransparencyOptions.CompareAlphaChannel, bool compareMetadata = false)
{
Expand All @@ -84,7 +84,7 @@ public static bool ImagesAreEqual(string pathImageActual, string pathImageExpect
/// <param name="resizeOption"></param>
/// <param name="pixelColorShiftTolerance"></param>
/// <param name="transparencyOptions"></param>
/// <param name="compareMetadata"></param>
/// <param name="compareMetadata">If true, compares image metadata (EXIF, etc.) in addition to pixel data.</param>
/// <returns>True if every pixel of actual is equal to expected</returns>
public static bool ImagesAreEqual(Stream actual, Stream expected, ResizeOption resizeOption = ResizeOption.DontResize, int pixelColorShiftTolerance = 0, TransparencyOptions transparencyOptions = TransparencyOptions.CompareAlphaChannel, bool compareMetadata = false)
{
Expand All @@ -111,7 +111,7 @@ public static bool ImagesAreEqual(Stream actual, Stream expected, ResizeOption r
/// <param name="resizeOption"></param>
/// <param name="transparencyOptions"></param>
/// <param name="pixelColorShiftTolerance"></param>
/// <param name="compareMetadata"></param>
/// <param name="compareMetadata">If true, compares image metadata (EXIF, etc.) in addition to pixel data.</param>
/// <returns>True if every pixel of actual is equal to expected</returns>
public static bool ImagesAreEqual(SKBitmap actual, SKBitmap expected, ResizeOption resizeOption = ResizeOption.DontResize, int pixelColorShiftTolerance = 0, TransparencyOptions transparencyOptions = TransparencyOptions.CompareAlphaChannel, bool compareMetadata = false)
{
Expand Down