liblzma: Add missing comments to lz_encoder.h.

(cherry picked from commit 84196e8c094402cb71b669fb9e984c56ebabb145)

diff --git a/src/liblzma/lz/lz_encoder.h b/src/liblzma/lz/lz_encoder.h
index 426dcd8a38750d5120bbe11e6e87103c229506dd..459bcb6b86990f553cbf92d85fa751fa1e714b5b 100644 (file)
--- a/src/liblzma/lz/lz_encoder.h
+++ b/src/liblzma/lz/lz_encoder.h
@@ -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;