diff options
| author | Jia Tan <jiat0218@gmail.com> | 2022-12-22 23:14:53 +0800 |
|---|---|---|
| committer | Lasse Collin <lasse.collin@tukaani.org> | 2023-03-11 21:34:26 +0200 |
| commit | 2155fef5285bd524a9b8476dd7d146d845c846a9 (patch) | |
| tree | 3651c0cc68d3990f2f210cc21e69cf0fb348ed62 | |
| parent | 7067c1ca6534bfb4a5f0293109e945d8316ebbf5 (diff) | |
| download | xz-2155fef5285bd524a9b8476dd7d146d845c846a9.tar.gz | |
liblzma: Update documentation for lzma_filter_encoder.
| -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 f0762d9..73f9e10 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. |