aboutsummaryrefslogtreecommitdiff
path: root/src/liblzma/api/lzma
diff options
context:
space:
mode:
authorLasse Collin <lasse.collin@tukaani.org>2018-05-19 21:23:25 +0300
committerLasse Collin <lasse.collin@tukaani.org>2018-05-19 21:23:25 +0300
commit76762ae6098ec55c326f4b4b4a42e8c1918ee81f (patch)
tree8c46041dbe454d0beabadafe666f9ba4ecc3944d /src/liblzma/api/lzma
parentBump the version number to 5.3.1alpha. (diff)
downloadxz-76762ae6098ec55c326f4b4b4a42e8c1918ee81f.tar.xz
liblzma: Improve lzma_properties_decode() API documentation.
Diffstat (limited to 'src/liblzma/api/lzma')
-rw-r--r--src/liblzma/api/lzma/filter.h7
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().