aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorJia Tan <jiat0218@gmail.com>2022-12-22 23:14:53 +0800
committerJia Tan <jiat0218@gmail.com>2022-12-30 23:34:31 +0800
commit1275ebfba74230dbd028049141423c79c8b83b8f (patch)
treee79d069053d3524af07cc36d90c7b1b4d3e5b4d7 /src
parentTests: Adds lzip decoder tests (diff)
downloadxz-1275ebfba74230dbd028049141423c79c8b83b8f.tar.xz
liblzma: Update documentation for lzma_filter_encoder.
Diffstat (limited to 'src')
-rw-r--r--src/liblzma/common/filter_encoder.c7
1 files changed, 5 insertions, 2 deletions
diff --git a/src/liblzma/common/filter_encoder.c b/src/liblzma/common/filter_encoder.c
index 978b7a6b..46fe8af1 100644
--- a/src/liblzma/common/filter_encoder.c
+++ b/src/liblzma/common/filter_encoder.c
@@ -37,9 +37,12 @@ typedef struct {
uint64_t (*block_size)(const void *options);
/// Tells the size of the Filter Properties field. If options are
- /// invalid, UINT32_MAX is returned. If this is NULL, props_size_fixed
- /// is used.
+ /// invalid, LZMA_OPTIONS_ERROR is returned and size is set to
+ /// UINT32_MAX.
lzma_ret (*props_size_get)(uint32_t *size, const void *options);
+
+ /// Some filters will always have the same size Filter Properties
+ /// field. If props_size_get is NULL, this value is used.
uint32_t props_size_fixed;
/// Encodes Filter Properties.