aboutsummaryrefslogtreecommitdiff
path: root/src/liblzma/api/lzma/stream_flags.h
diff options
context:
space:
mode:
authorLasse Collin <lasse.collin@tukaani.org>2023-02-16 21:09:00 +0200
committerJia Tan <jiat0218@gmail.com>2023-03-07 23:23:19 +0800
commitbc34e5ac9996667d2c1ec9a7895ec5931ac4caea (patch)
treef23e82886a50ea59d457b6d334e6aa735d9db324 /src/liblzma/api/lzma/stream_flags.h
parentliblzma: Adjust spacing in doc headers in bcj.h. (diff)
downloadxz-bc34e5ac9996667d2c1ec9a7895ec5931ac4caea.tar.xz
liblzma: Very minor API doc tweaks.
Use "member" to refer to struct members as that's the term used by the C standard. Use lzma_options_delta.dist and such in docs so that in Doxygen's HTML output they will link to the doc of the struct member. Clean up a few trailing white spaces too.
Diffstat (limited to '')
-rw-r--r--src/liblzma/api/lzma/stream_flags.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/liblzma/api/lzma/stream_flags.h b/src/liblzma/api/lzma/stream_flags.h
index e259b085..253706e2 100644
--- a/src/liblzma/api/lzma/stream_flags.h
+++ b/src/liblzma/api/lzma/stream_flags.h
@@ -37,7 +37,7 @@ typedef struct {
*
* To prevent API and ABI breakages if new features are needed in
* Stream Header or Stream Footer, a version number is used to
- * indicate which fields in this structure are in use. For now,
+ * indicate which members in this structure are in use. For now,
* version must always be zero. With non-zero version, the
* lzma_stream_header_encode() and lzma_stream_footer_encode()
* will return LZMA_OPTIONS_ERROR.
@@ -70,12 +70,12 @@ typedef struct {
lzma_vli backward_size;
/**
- * \brief Minimum size of the backward_size member
+ * \brief Minimum value for lzma_stream_flags.backward_size
*/
# define LZMA_BACKWARD_SIZE_MIN 4
/**
- * \brief Maximum size of the backward_size member
+ * \brief Maximum value for lzma_stream_flags.backward_size
*/
# define LZMA_BACKWARD_SIZE_MAX (LZMA_VLI_C(1) << 34)