aboutsummaryrefslogtreecommitdiff
path: root/src/liblzma/api/lzma/lzma12.h
diff options
context:
space:
mode:
authorJia Tan <jiat0218@gmail.com>2023-02-17 00:36:05 +0800
committerJia Tan <jiat0218@gmail.com>2023-03-07 23:22:46 +0800
commit762c4d0b62d2694cf3a01e030fdfe68e09e7b503 (patch)
tree16931f373a713a0f1dfec3f0b394b1cd901baa6c /src/liblzma/api/lzma/lzma12.h
parentliblzma: Silence a warning from MSVC. (diff)
downloadxz-762c4d0b62d2694cf3a01e030fdfe68e09e7b503.tar.xz
liblzma: Rename field => member in documentation.
Also adjusted preset value => preset level.
Diffstat (limited to 'src/liblzma/api/lzma/lzma12.h')
-rw-r--r--src/liblzma/api/lzma/lzma12.h28
1 files changed, 14 insertions, 14 deletions
diff --git a/src/liblzma/api/lzma/lzma12.h b/src/liblzma/api/lzma/lzma12.h
index dcc762df..3d3723f9 100644
--- a/src/liblzma/api/lzma/lzma12.h
+++ b/src/liblzma/api/lzma/lzma12.h
@@ -492,37 +492,37 @@ typedef struct {
* uninitialized.
*/
- /** \private Reserved field. */
+ /** \private Reserved member. */
uint32_t reserved_int4;
- /** \private Reserved field. */
+ /** \private Reserved member. */
uint32_t reserved_int5;
- /** \private Reserved field. */
+ /** \private Reserved member. */
uint32_t reserved_int6;
- /** \private Reserved field. */
+ /** \private Reserved member. */
uint32_t reserved_int7;
- /** \private Reserved field. */
+ /** \private Reserved member. */
uint32_t reserved_int8;
- /** \private Reserved field. */
+ /** \private Reserved member. */
lzma_reserved_enum reserved_enum1;
- /** \private Reserved field. */
+ /** \private Reserved member. */
lzma_reserved_enum reserved_enum2;
- /** \private Reserved field. */
+ /** \private Reserved member. */
lzma_reserved_enum reserved_enum3;
- /** \private Reserved field. */
+ /** \private Reserved member. */
lzma_reserved_enum reserved_enum4;
- /** \private Reserved field. */
+ /** \private Reserved member. */
void *reserved_ptr1;
- /** \private Reserved field. */
+ /** \private Reserved member. */
void *reserved_ptr2;
} lzma_options_lzma;
@@ -550,13 +550,13 @@ do { \
* The flags are defined in container.h, because the flags are used also
* with lzma_easy_encoder().
*
- * The preset values are subject to changes between liblzma versions.
+ * The preset levels are subject to changes between liblzma versions.
*
* This function is available only if LZMA1 or LZMA2 encoder has been enabled
* when building liblzma.
*
- * \param[out] options Pointer to LZMA12 options to be filled
- * \param preset Preset value between 0-9 ORed with preset flags
+ * \param[out] options Pointer to LZMA1 or LZMA2 options to be filled
+ * \param preset Preset level bitwse-ORed with preset flags
*
* \return lzma_bool:
* - true if the preset is not supported (failure).