root
/
xz
mirror of https://git.tukaani.org/xz.git
1
0
Fork 0
Code Issues Releases Wiki Activity

liblzma: Rename field => member in documentation. 

Also adjusted preset value => preset level.
This commit is contained in:
Jia Tan 2023-02-17 00:36:05 +08:00
parent 0ce1db0223
commit 762c4d0b62
7 changed files with 95 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/liblzma/api/lzma/base.h
View File

@ -548,16 +548,16 @@ typedef struct {
* may change. * may change.
*/ */
/** \private Reserved field. */ /** \private Reserved member. */
void *reserved_ptr1; void *reserved_ptr1;
/** \private Reserved field. */ /** \private Reserved member. */
void *reserved_ptr2; void *reserved_ptr2;
/** \private Reserved field. */ /** \private Reserved member. */
void *reserved_ptr3; void *reserved_ptr3;
/** \private Reserved field. */ /** \private Reserved member. */
void *reserved_ptr4; void *reserved_ptr4;
/** /**
@ -572,19 +572,19 @@ typedef struct {
*/ */
uint64_t seek_pos; uint64_t seek_pos;
/** \private Reserved field. */ /** \private Reserved member. */
uint64_t reserved_int2; uint64_t reserved_int2;
/** \private Reserved field. */ /** \private Reserved member. */
size_t reserved_int3; size_t reserved_int3;
/** \private Reserved field. */ /** \private Reserved member. */
size_t reserved_int4; size_t reserved_int4;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_reserved_enum reserved_enum1; lzma_reserved_enum reserved_enum1;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_reserved_enum reserved_enum2; lzma_reserved_enum reserved_enum2;
} lzma_stream; } lzma_stream;

44
src/liblzma/api/lzma/block.h
View File

@ -238,49 +238,49 @@ typedef struct {
* uninitialized. * uninitialized.
*/ */
/** \private Reserved field. */ /** \private Reserved member. */
void *reserved_ptr1; void *reserved_ptr1;
/** \private Reserved field. */ /** \private Reserved member. */
void *reserved_ptr2; void *reserved_ptr2;
/** \private Reserved field. */ /** \private Reserved member. */
void *reserved_ptr3; void *reserved_ptr3;
/** \private Reserved field. */ /** \private Reserved member. */
uint32_t reserved_int1; uint32_t reserved_int1;
/** \private Reserved field. */ /** \private Reserved member. */
uint32_t reserved_int2; uint32_t reserved_int2;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_vli reserved_int3; lzma_vli reserved_int3;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_vli reserved_int4; lzma_vli reserved_int4;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_vli reserved_int5; lzma_vli reserved_int5;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_vli reserved_int6; lzma_vli reserved_int6;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_vli reserved_int7; lzma_vli reserved_int7;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_vli reserved_int8; lzma_vli reserved_int8;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_reserved_enum reserved_enum1; lzma_reserved_enum reserved_enum1;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_reserved_enum reserved_enum2; lzma_reserved_enum reserved_enum2;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_reserved_enum reserved_enum3; lzma_reserved_enum reserved_enum3;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_reserved_enum reserved_enum4; lzma_reserved_enum reserved_enum4;
/** /**
@ -304,25 +304,25 @@ typedef struct {
*/ */
lzma_bool ignore_check; lzma_bool ignore_check;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_bool reserved_bool2; lzma_bool reserved_bool2;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_bool reserved_bool3; lzma_bool reserved_bool3;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_bool reserved_bool4; lzma_bool reserved_bool4;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_bool reserved_bool5; lzma_bool reserved_bool5;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_bool reserved_bool6; lzma_bool reserved_bool6;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_bool reserved_bool7; lzma_bool reserved_bool7;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_bool reserved_bool8; lzma_bool reserved_bool8;
} lzma_block; } lzma_block;

26
src/liblzma/api/lzma/container.h
View File

@ -172,25 +172,25 @@ typedef struct {
* with the currently supported options, so it is safe to leave these * with the currently supported options, so it is safe to leave these
* uninitialized. * uninitialized.
*/ */
/** \private Reserved field. */ /** \private Reserved member. */
lzma_reserved_enum reserved_enum1; lzma_reserved_enum reserved_enum1;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_reserved_enum reserved_enum2; lzma_reserved_enum reserved_enum2;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_reserved_enum reserved_enum3; lzma_reserved_enum reserved_enum3;
/** \private Reserved field. */ /** \private Reserved member. */
uint32_t reserved_int1; uint32_t reserved_int1;
/** \private Reserved field. */ /** \private Reserved member. */
uint32_t reserved_int2; uint32_t reserved_int2;
/** \private Reserved field. */ /** \private Reserved member. */
uint32_t reserved_int3; uint32_t reserved_int3;
/** \private Reserved field. */ /** \private Reserved member. */
uint32_t reserved_int4; uint32_t reserved_int4;
/** /**
@ -236,22 +236,22 @@ typedef struct {
*/ */
uint64_t memlimit_stop; uint64_t memlimit_stop;
/** \private Reserved field. */ /** \private Reserved member. */
uint64_t reserved_int7; uint64_t reserved_int7;
/** \private Reserved field. */ /** \private Reserved member. */
uint64_t reserved_int8; uint64_t reserved_int8;
/** \private Reserved field. */ /** \private Reserved member. */
void *reserved_ptr1; void *reserved_ptr1;
/** \private Reserved field. */ /** \private Reserved member. */
void *reserved_ptr2; void *reserved_ptr2;
/** \private Reserved field. */ /** \private Reserved member. */
void *reserved_ptr3; void *reserved_ptr3;
/** \private Reserved field. */ /** \private Reserved member. */
void *reserved_ptr4; void *reserved_ptr4;
} lzma_mt; } lzma_mt;

12
src/liblzma/api/lzma/delta.h
View File

@ -77,22 +77,22 @@ typedef struct {
* uninitialized. * uninitialized.
*/ */
/** \private Reserved field. */ /** \private Reserved member. */
uint32_t reserved_int1; uint32_t reserved_int1;
/** \private Reserved field. */ /** \private Reserved member. */
uint32_t reserved_int2; uint32_t reserved_int2;
/** \private Reserved field. */ /** \private Reserved member. */
uint32_t reserved_int3; uint32_t reserved_int3;
/** \private Reserved field. */ /** \private Reserved member. */
uint32_t reserved_int4; uint32_t reserved_int4;
/** \private Reserved field. */ /** \private Reserved member. */
void *reserved_ptr1; void *reserved_ptr1;
/** \private Reserved field. */ /** \private Reserved member. */
void *reserved_ptr2; void *reserved_ptr2;
} lzma_options_delta; } lzma_options_delta;

30
src/liblzma/api/lzma/index.h
View File

@ -51,13 +51,13 @@ typedef struct {
*/ */
const lzma_stream_flags *flags; const lzma_stream_flags *flags;
/** \private Reserved field. */ /** \private Reserved member. */
const void *reserved_ptr1; const void *reserved_ptr1;
/** \private Reserved field. */ /** \private Reserved member. */
const void *reserved_ptr2; const void *reserved_ptr2;
/** \private Reserved field. */ /** \private Reserved member. */
const void *reserved_ptr3; const void *reserved_ptr3;
/** /**
@ -114,16 +114,16 @@ typedef struct {
lzma_vli padding; lzma_vli padding;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_vli reserved_vli1; lzma_vli reserved_vli1;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_vli reserved_vli2; lzma_vli reserved_vli2;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_vli reserved_vli3; lzma_vli reserved_vli3;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_vli reserved_vli4; lzma_vli reserved_vli4;
} stream; } stream;
@ -210,28 +210,28 @@ typedef struct {
*/ */
lzma_vli total_size; lzma_vli total_size;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_vli reserved_vli1; lzma_vli reserved_vli1;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_vli reserved_vli2; lzma_vli reserved_vli2;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_vli reserved_vli3; lzma_vli reserved_vli3;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_vli reserved_vli4; lzma_vli reserved_vli4;
/** \private Reserved field. */ /** \private Reserved member. */
const void *reserved_ptr1; const void *reserved_ptr1;
/** \private Reserved field. */ /** \private Reserved member. */
const void *reserved_ptr2; const void *reserved_ptr2;
/** \private Reserved field. */ /** \private Reserved member. */
const void *reserved_ptr3; const void *reserved_ptr3;
/** \private Reserved field. */ /** \private Reserved member. */
const void *reserved_ptr4; const void *reserved_ptr4;
} block; } block;

28
src/liblzma/api/lzma/lzma12.h
View File

@ -492,37 +492,37 @@ typedef struct {
* uninitialized. * uninitialized.
*/ */
/** \private Reserved field. */ /** \private Reserved member. */
uint32_t reserved_int4; uint32_t reserved_int4;
/** \private Reserved field. */ /** \private Reserved member. */
uint32_t reserved_int5; uint32_t reserved_int5;
/** \private Reserved field. */ /** \private Reserved member. */
uint32_t reserved_int6; uint32_t reserved_int6;
/** \private Reserved field. */ /** \private Reserved member. */
uint32_t reserved_int7; uint32_t reserved_int7;
/** \private Reserved field. */ /** \private Reserved member. */
uint32_t reserved_int8; uint32_t reserved_int8;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_reserved_enum reserved_enum1; lzma_reserved_enum reserved_enum1;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_reserved_enum reserved_enum2; lzma_reserved_enum reserved_enum2;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_reserved_enum reserved_enum3; lzma_reserved_enum reserved_enum3;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_reserved_enum reserved_enum4; lzma_reserved_enum reserved_enum4;
/** \private Reserved field. */ /** \private Reserved member. */
void *reserved_ptr1; void *reserved_ptr1;
/** \private Reserved field. */ /** \private Reserved member. */
void *reserved_ptr2; void *reserved_ptr2;
} lzma_options_lzma; } lzma_options_lzma;
@ -550,13 +550,13 @@ do { \
* The flags are defined in container.h, because the flags are used also * The flags are defined in container.h, because the flags are used also
* with lzma_easy_encoder(). * 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 * This function is available only if LZMA1 or LZMA2 encoder has been enabled
* when building liblzma. * when building liblzma.
* *
* \param[out] options Pointer to LZMA12 options to be filled * \param[out] options Pointer to LZMA1 or LZMA2 options to be filled
* \param preset Preset value between 0-9 ORed with preset flags * \param preset Preset level bitwse-ORed with preset flags
* *
* \return lzma_bool: * \return lzma_bool:
* - true if the preset is not supported (failure). * - true if the preset is not supported (failure).

32
src/liblzma/api/lzma/stream_flags.h
View File

@ -70,12 +70,12 @@ typedef struct {
lzma_vli backward_size; lzma_vli backward_size;
/** /**
* \brief Minimum size of the backward_size field * \brief Minimum size of the backward_size member
*/ */
# define LZMA_BACKWARD_SIZE_MIN 4 # define LZMA_BACKWARD_SIZE_MIN 4
/** /**
* \brief Maximum size of the backward_size field * \brief Maximum size of the backward_size member
*/ */
# define LZMA_BACKWARD_SIZE_MAX (LZMA_VLI_C(1) << 34) # define LZMA_BACKWARD_SIZE_MAX (LZMA_VLI_C(1) << 34)
@ -97,46 +97,46 @@ typedef struct {
* nice to have the proper types when they are needed.) * nice to have the proper types when they are needed.)
*/ */
/** \private Reserved field. */ /** \private Reserved member. */
lzma_reserved_enum reserved_enum1; lzma_reserved_enum reserved_enum1;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_reserved_enum reserved_enum2; lzma_reserved_enum reserved_enum2;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_reserved_enum reserved_enum3; lzma_reserved_enum reserved_enum3;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_reserved_enum reserved_enum4; lzma_reserved_enum reserved_enum4;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_bool reserved_bool1; lzma_bool reserved_bool1;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_bool reserved_bool2; lzma_bool reserved_bool2;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_bool reserved_bool3; lzma_bool reserved_bool3;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_bool reserved_bool4; lzma_bool reserved_bool4;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_bool reserved_bool5; lzma_bool reserved_bool5;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_bool reserved_bool6; lzma_bool reserved_bool6;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_bool reserved_bool7; lzma_bool reserved_bool7;
/** \private Reserved field. */ /** \private Reserved member. */
lzma_bool reserved_bool8; lzma_bool reserved_bool8;
/** \private Reserved field. */ /** \private Reserved member. */
uint32_t reserved_int1; uint32_t reserved_int1;
/** \private Reserved field. */ /** \private Reserved member. */
uint32_t reserved_int2; uint32_t reserved_int2;
} lzma_stream_flags; } lzma_stream_flags;