search

strukturag / libheif

libheif is an HEIF and AVIF file format decoder and encoder.
Other
1.71k stars 298 forks source link

compression: add (internal) api documentation for compression #1230

Closed bradh closed 2 months ago

bradh commented 2 months ago

This is a follow-up to the recent work on compression / decompression, adding some internal documentation on those.

It isn't going to show up in the Doxygen since its not public API. Depending on editor, it may show up as a hint. For example, in VS Code, it appears on hover:

image

bradh commented 2 months ago

See #1231 for a proposed fix on the fuzzer failure.

farindk commented 2 months ago

For example, in VS Code, it appears on hover:

Thanks. Also shows in CLion.