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

Wrong description for bool Exiv2::Image::iccProfileDefined() #1953

Closed
trufanov-nok opened this issue Oct 9, 2021 · 2 comments · Fixed by #1964
Closed

Wrong description for bool Exiv2::Image::iccProfileDefined() #1953

trufanov-nok opened this issue Oct 9, 2021 · 2 comments · Fixed by #1964
Assignees
Milestone

Comments

@trufanov-nok
Copy link

It's the same as for void clearIccProfile ().:

virtual void clearIccProfile ()
Erase iccProfile. the profile is not removed from the actual image until the writeMetadata() method is called.
 
virtual bool iccProfileDefined ()
Erase iccProfile. the profile is not removed from the actual image until the writeMetadata() method is called.

I've noticed this on a website: https://exiv2.org/doc/classExiv2_1_1Image.html
It seems the doc is autogenerated from this header:
https://github.com/Exiv2/exiv2/blob/main/include/exiv2/image.hpp#L232

@trufanov-nok trufanov-nok changed the title Wrong description for void Exiv2::Image::iccProfileDefined() Wrong description for bool Exiv2::Image::iccProfileDefined() Oct 9, 2021
@clanmills
Copy link
Collaborator

clanmills commented Oct 9, 2021

Alex. @trufanov-nok Thanks for letting us know. You're correct. The API documentation is generated from the comments in the header file using Doxygen. We do a little post-processing on the doxygen to modify the look'n'feel of the pages.

clearIccProfile() deletes the icc profile in the image instance. The file is rewritten with image->writeMetadata()

iccProfileDefined() returns the status of the ICC profile in the image instance. Peter @postscript-dev can you create a PR for those changes, please.

@postscript-dev
Copy link
Collaborator

I will look at this later in the week.

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.

3 participants