diff options
| author | Lasse Collin <lasse.collin@tukaani.org> | 2018-05-19 21:23:25 +0300 |
|---|---|---|
| committer | Lasse Collin <lasse.collin@tukaani.org> | 2019-07-13 17:17:00 +0300 |
| commit | 65b4aba6d06d2cd24ba9ad01fa389c238ad8f352 (patch) | |
| tree | 7ee8058c91efd2b345a45c66944b35bfb57154fb | |
| parent | Update THANKS. (diff) | |
| download | xz-65b4aba6d06d2cd24ba9ad01fa389c238ad8f352.tar.xz | |
liblzma: Improve lzma_properties_decode() API documentation.
| -rw-r--r-- | src/liblzma/api/lzma/filter.h | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/src/liblzma/api/lzma/filter.h b/src/liblzma/api/lzma/filter.h index 4e78752b..8c859314 100644 --- a/src/liblzma/api/lzma/filter.h +++ b/src/liblzma/api/lzma/filter.h @@ -341,9 +341,10 @@ extern LZMA_API(lzma_ret) lzma_properties_encode( * \param filter filter->id must have been set to the correct * Filter ID. filter->options doesn't need to be * initialized (it's not freed by this function). The - * decoded options will be stored to filter->options. - * filter->options is set to NULL if there are no - * properties or if an error occurs. + * decoded options will be stored in filter->options; + * it's application's responsibility to free it when + * appropriate. filter->options is set to NULL if + * there are no properties or if an error occurs. * \param allocator Custom memory allocator used to allocate the * options. Set to NULL to use the default malloc(), * and in case of an error, also free(). |