diff options
| author | Jia Tan <jiat0218@gmail.com> | 2022-12-22 23:14:53 +0800 |
|---|---|---|
| committer | Jia Tan <jiat0218@gmail.com> | 2022-12-28 01:20:27 +0800 |
| commit | e84f2ab7f8bc38cd8f8befa0bb398656c3c11f8e (patch) | |
| tree | e79d069053d3524af07cc36d90c7b1b4d3e5b4d7 /src/liblzma | |
| parent | Tests: Adds lzip decoder tests (diff) | |
| download | xz-e84f2ab7f8bc38cd8f8befa0bb398656c3c11f8e.tar.xz | |
liblzma: Update documentation for lzma_filter_encoder.
Diffstat (limited to 'src/liblzma')
| -rw-r--r-- | src/liblzma/common/filter_encoder.c | 7 |
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. |