flac icon indicating copy to clipboard operation
flac copied to clipboard
verified publisher icon xiph

API porting documentation unclear - changes in 1.5.0 and older versions

Open xuijuthub opened this issue 3 months ago • 2 comments

Looking at documentation porting guides API levels are not menioned.. Seems to require guesswork or digging old versions for changes on compile errors to determine which API level implemented what. https://github.com/mixxxdj/mixxx/pull/15293#issuecomment-3249277655

I believe there should be more attention documenting API changes, or random bugs caused by changes might overwhelm and disencourage users to update.

xuijuthub avatar Sep 03 '25 16:09 xuijuthub

Have you seen this: https://xiph.org/flac/api/group__porting.html

Seems pretty comprehensive to me?

ktmf01 avatar Sep 03 '25 16:09 ktmf01

Yes, it does not specify the fact API level was incremented (causes people think by intuition that 1.4 is 14, 1.5 is 15), or that more error types were added FLAC__STREAM_DECODER_ERROR_STATUS_OUT_OF_BOUNDS FLAC__STREAM_DECODER_ERROR_STATUS_MISSING_FRAME although that might not be a problem if it's just a warning, but still would be nice to see those additions as changes in API documentation.

Just a heads up. Thank you.

xuijuthub avatar Sep 03 '25 17:09 xuijuthub