From: Jia Tan <jiat0218@gmail.com>
Date: Thu, 22 Dec 2022 15:14:53 +0000 (+0800)
Subject: liblzma: Update documentation for lzma_filter_encoder.
X-Git-Tag: v5.2.11~22
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2155fef5285bd524a9b8476dd7d146d845c846a9;p=thirdparty%2Fxz.git

liblzma: Update documentation for lzma_filter_encoder.
---

diff --git a/src/liblzma/common/filter_encoder.c b/src/liblzma/common/filter_encoder.c
index f0762d9a..73f9e106 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.