]> git.ipfire.org Git - thirdparty/xz.git/commitdiff
liblzma: Improve lzma_properties_decode() API documentation.
authorLasse Collin <lasse.collin@tukaani.org>
Sat, 19 May 2018 18:23:25 +0000 (21:23 +0300)
committerLasse Collin <lasse.collin@tukaani.org>
Sat, 19 May 2018 18:23:25 +0000 (21:23 +0300)
src/liblzma/api/lzma/filter.h

index 4e78752b8f795ebc4a699045609ea0758ece1562..8c85931476588c65fd7e2c38a650410c371a4707 100644 (file)
@@ -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().