Skip to content
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.

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

IccProfile Comment is Incorrect #2287

Closed
4 tasks done
pha3z opened this issue Nov 1, 2022 · 1 comment · Fixed by #2306
Closed
4 tasks done

IccProfile Comment is Incorrect #2287

pha3z opened this issue Nov 1, 2022 · 1 comment · Fixed by #2306

Comments

@pha3z
Copy link

pha3z commented Nov 1, 2022

Prerequisites

  • I have written a descriptive issue title
  • I have verified that I am running the latest version of ImageSharp
  • I have verified if the problem exist in both DEBUG and RELEASE mode
  • I have searched open and closed issues to ensure it has not already been reported

ImageSharp version

2.1.3

Other ImageSharp packages and versions

none

Environment (Operating system, version and so on)

Windows 10

.NET Framework version

.NET 5

Description

XML Comment for IImageInfo.Metadata.ICCProfile appears to be incorrect.

It says

Gets or sets the list of ICC profiles.

But it returns a single ICC Profile (as expected). The comment confused me and made me wonder if there's actually supposed to be a way to get multiple profiles.

Comment should probably read:

Gets or sets the ICC profile.

Steps to Reproduce

Create a new project and use ImageSharp to Identify a file:

var info = SixLabors.ImageSharp.Image.Identify(imgFilepath);
var icc = info.Metadata.IccProfile;

Highlight over "IccProfile" to see the intellisense XML comment.

Images

No response

@JimBobSquarePants
Copy link
Member

Thanks for this. Please open a PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants