Frommi / miniz_oxide

Rust replacement for miniz
MIT License
168 stars 48 forks source link

Attempt to add some documentation to external API's. #108

Closed fullermd closed 2 years ago

fullermd commented 2 years ago

This attempts to add some documentation onto the core and streaming in/deflate functions, their controlling arguments, and their various return values. Details were found via inspection of code (and occasional reference to the miniz C code), and are believed reasonable as far as they go, but I can't guarantee I have a particularly good understanding of everything.

oyvindln commented 2 years ago

Nice work!