SixLabors / ImageSharp

:camera: A modern, cross-platform, 2D Graphics library for .NET
https://sixlabors.com/products/imagesharp/
Other
7.45k stars 853 forks source link

IccProfile Comment is Incorrect #2287

Closed pha3z closed 1 year ago

pha3z commented 2 years ago

Prerequisites

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 commented 2 years ago

Thanks for this. Please open a PR.