]> git.ipfire.org Git - thirdparty/xz.git/commitdiff
liblzma: Add missing comments to lz_encoder.h.
authorJia Tan <jiat0218@gmail.com>
Wed, 8 Nov 2023 17:21:53 +0000 (01:21 +0800)
committerJia Tan <jiat0218@gmail.com>
Fri, 22 Dec 2023 12:02:03 +0000 (20:02 +0800)
src/liblzma/lz/lz_encoder.h

index ffcba02ce93139f131a7cd6b2c7d967e466d3b61..8d9c6d6e94146d7b3b61da29617da1e59763c0d7 100644 (file)
@@ -153,9 +153,13 @@ typedef struct {
        /// Maximum search depth
        uint32_t depth;
 
-       /// TODO: Comment
+       /// Initial dictionary for the match finder to search.
        const uint8_t *preset_dict;
 
+       /// If the preset dictionary is NULL, this value is ignored.
+       /// Otherwise this member must indicate the preset dictionary's
+       /// buffer size. If this size is larger than dict_size, then only
+       /// the dict_size sized tail of the preset_dict will be used.
        uint32_t preset_dict_size;
 
 } lzma_lz_options;