1
0
Fork 0
mirror of https://git.tukaani.org/xz.git synced 2024-04-04 12:36:23 +02:00

liblzma: Set documentation on all reserved fields to private.

This prevents the reserved fields from being part of the generated
Doxygen documentation.
This commit is contained in:
Jia Tan 2023-01-20 21:53:14 +08:00
parent 6327a045f3
commit 9663141274
7 changed files with 173 additions and 0 deletions

View file

@ -547,9 +547,17 @@ typedef struct {
* you should not touch these, because the names of these variables * you should not touch these, because the names of these variables
* may change. * may change.
*/ */
/** \private Reserved field. */
void *reserved_ptr1; void *reserved_ptr1;
/** \private Reserved field. */
void *reserved_ptr2; void *reserved_ptr2;
/** \private Reserved field. */
void *reserved_ptr3; void *reserved_ptr3;
/** \private Reserved field. */
void *reserved_ptr4; void *reserved_ptr4;
/** /**
@ -564,10 +572,19 @@ typedef struct {
*/ */
uint64_t seek_pos; uint64_t seek_pos;
/** \private Reserved field. */
uint64_t reserved_int2; uint64_t reserved_int2;
/** \private Reserved field. */
size_t reserved_int3; size_t reserved_int3;
/** \private Reserved field. */
size_t reserved_int4; size_t reserved_int4;
/** \private Reserved field. */
lzma_reserved_enum reserved_enum1; lzma_reserved_enum reserved_enum1;
/** \private Reserved field. */
lzma_reserved_enum reserved_enum2; lzma_reserved_enum reserved_enum2;
} lzma_stream; } lzma_stream;

View file

@ -224,20 +224,50 @@ 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. */
void *reserved_ptr1; void *reserved_ptr1;
/** \private Reserved field. */
void *reserved_ptr2; void *reserved_ptr2;
/** \private Reserved field. */
void *reserved_ptr3; void *reserved_ptr3;
/** \private Reserved field. */
uint32_t reserved_int1; uint32_t reserved_int1;
/** \private Reserved field. */
uint32_t reserved_int2; uint32_t reserved_int2;
/** \private Reserved field. */
lzma_vli reserved_int3; lzma_vli reserved_int3;
/** \private Reserved field. */
lzma_vli reserved_int4; lzma_vli reserved_int4;
/** \private Reserved field. */
lzma_vli reserved_int5; lzma_vli reserved_int5;
/** \private Reserved field. */
lzma_vli reserved_int6; lzma_vli reserved_int6;
/** \private Reserved field. */
lzma_vli reserved_int7; lzma_vli reserved_int7;
/** \private Reserved field. */
lzma_vli reserved_int8; lzma_vli reserved_int8;
/** \private Reserved field. */
lzma_reserved_enum reserved_enum1; lzma_reserved_enum reserved_enum1;
/** \private Reserved field. */
lzma_reserved_enum reserved_enum2; lzma_reserved_enum reserved_enum2;
/** \private Reserved field. */
lzma_reserved_enum reserved_enum3; lzma_reserved_enum reserved_enum3;
/** \private Reserved field. */
lzma_reserved_enum reserved_enum4; lzma_reserved_enum reserved_enum4;
/** /**
@ -261,12 +291,25 @@ typedef struct {
*/ */
lzma_bool ignore_check; lzma_bool ignore_check;
/** \private Reserved field. */
lzma_bool reserved_bool2; lzma_bool reserved_bool2;
/** \private Reserved field. */
lzma_bool reserved_bool3; lzma_bool reserved_bool3;
/** \private Reserved field. */
lzma_bool reserved_bool4; lzma_bool reserved_bool4;
/** \private Reserved field. */
lzma_bool reserved_bool5; lzma_bool reserved_bool5;
/** \private Reserved field. */
lzma_bool reserved_bool6; lzma_bool reserved_bool6;
/** \private Reserved field. */
lzma_bool reserved_bool7; lzma_bool reserved_bool7;
/** \private Reserved field. */
lzma_bool reserved_bool8; lzma_bool reserved_bool8;
} lzma_block; } lzma_block;

View file

@ -172,12 +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. */
lzma_reserved_enum reserved_enum1; lzma_reserved_enum reserved_enum1;
/** \private Reserved field. */
lzma_reserved_enum reserved_enum2; lzma_reserved_enum reserved_enum2;
/** \private Reserved field. */
lzma_reserved_enum reserved_enum3; lzma_reserved_enum reserved_enum3;
/** \private Reserved field. */
uint32_t reserved_int1; uint32_t reserved_int1;
/** \private Reserved field. */
uint32_t reserved_int2; uint32_t reserved_int2;
/** \private Reserved field. */
uint32_t reserved_int3; uint32_t reserved_int3;
/** \private Reserved field. */
uint32_t reserved_int4; uint32_t reserved_int4;
/** /**
@ -223,11 +236,22 @@ typedef struct {
*/ */
uint64_t memlimit_stop; uint64_t memlimit_stop;
/** \private Reserved field. */
uint64_t reserved_int7; uint64_t reserved_int7;
/** \private Reserved field. */
uint64_t reserved_int8; uint64_t reserved_int8;
/** \private Reserved field. */
void *reserved_ptr1; void *reserved_ptr1;
/** \private Reserved field. */
void *reserved_ptr2; void *reserved_ptr2;
/** \private Reserved field. */
void *reserved_ptr3; void *reserved_ptr3;
/** \private Reserved field. */
void *reserved_ptr4; void *reserved_ptr4;
} lzma_mt; } lzma_mt;

View file

@ -68,11 +68,23 @@ typedef struct {
* when type is LZMA_DELTA_TYPE_BYTE, so it is safe to leave these * when type is LZMA_DELTA_TYPE_BYTE, so it is safe to leave these
* uninitialized. * uninitialized.
*/ */
/** \private Reserved field. */
uint32_t reserved_int1; uint32_t reserved_int1;
/** \private Reserved field. */
uint32_t reserved_int2; uint32_t reserved_int2;
/** \private Reserved field. */
uint32_t reserved_int3; uint32_t reserved_int3;
/** \private Reserved field. */
uint32_t reserved_int4; uint32_t reserved_int4;
/** \private Reserved field. */
void *reserved_ptr1; void *reserved_ptr1;
/** \private Reserved field. */
void *reserved_ptr2; void *reserved_ptr2;
} lzma_options_delta; } lzma_options_delta;

View file

@ -51,8 +51,13 @@ typedef struct {
*/ */
const lzma_stream_flags *flags; const lzma_stream_flags *flags;
/** \private Reserved field. */
const void *reserved_ptr1; const void *reserved_ptr1;
/** \private Reserved field. */
const void *reserved_ptr2; const void *reserved_ptr2;
/** \private Reserved field. */
const void *reserved_ptr3; const void *reserved_ptr3;
/** /**
@ -108,9 +113,17 @@ typedef struct {
*/ */
lzma_vli padding; lzma_vli padding;
/** \private Reserved field. */
lzma_vli reserved_vli1; lzma_vli reserved_vli1;
/** \private Reserved field. */
lzma_vli reserved_vli2; lzma_vli reserved_vli2;
/** \private Reserved field. */
lzma_vli reserved_vli3; lzma_vli reserved_vli3;
/** \private Reserved field. */
lzma_vli reserved_vli4; lzma_vli reserved_vli4;
} stream; } stream;
@ -197,14 +210,28 @@ typedef struct {
*/ */
lzma_vli total_size; lzma_vli total_size;
/** \private Reserved field. */
lzma_vli reserved_vli1; lzma_vli reserved_vli1;
/** \private Reserved field. */
lzma_vli reserved_vli2; lzma_vli reserved_vli2;
/** \private Reserved field. */
lzma_vli reserved_vli3; lzma_vli reserved_vli3;
/** \private Reserved field. */
lzma_vli reserved_vli4; lzma_vli reserved_vli4;
/** \private Reserved field. */
const void *reserved_ptr1; const void *reserved_ptr1;
/** \private Reserved field. */
const void *reserved_ptr2; const void *reserved_ptr2;
/** \private Reserved field. */
const void *reserved_ptr3; const void *reserved_ptr3;
/** \private Reserved field. */
const void *reserved_ptr4; const void *reserved_ptr4;
} block; } block;

View file

@ -481,16 +481,38 @@ 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. */
uint32_t reserved_int4; uint32_t reserved_int4;
/** \private Reserved field. */
uint32_t reserved_int5; uint32_t reserved_int5;
/** \private Reserved field. */
uint32_t reserved_int6; uint32_t reserved_int6;
/** \private Reserved field. */
uint32_t reserved_int7; uint32_t reserved_int7;
/** \private Reserved field. */
uint32_t reserved_int8; uint32_t reserved_int8;
/** \private Reserved field. */
lzma_reserved_enum reserved_enum1; lzma_reserved_enum reserved_enum1;
/** \private Reserved field. */
lzma_reserved_enum reserved_enum2; lzma_reserved_enum reserved_enum2;
/** \private Reserved field. */
lzma_reserved_enum reserved_enum3; lzma_reserved_enum reserved_enum3;
/** \private Reserved field. */
lzma_reserved_enum reserved_enum4; lzma_reserved_enum reserved_enum4;
/** \private Reserved field. */
void *reserved_ptr1; void *reserved_ptr1;
/** \private Reserved field. */
void *reserved_ptr2; void *reserved_ptr2;
} lzma_options_lzma; } lzma_options_lzma;

View file

@ -88,19 +88,47 @@ typedef struct {
* is just two bytes plus Backward Size of four bytes. But it's * is just two bytes plus Backward Size of four bytes. But it's
* nice to have the proper types when they are needed.) * nice to have the proper types when they are needed.)
*/ */
/** \private Reserved field. */
lzma_reserved_enum reserved_enum1; lzma_reserved_enum reserved_enum1;
/** \private Reserved field. */
lzma_reserved_enum reserved_enum2; lzma_reserved_enum reserved_enum2;
/** \private Reserved field. */
lzma_reserved_enum reserved_enum3; lzma_reserved_enum reserved_enum3;
/** \private Reserved field. */
lzma_reserved_enum reserved_enum4; lzma_reserved_enum reserved_enum4;
/** \private Reserved field. */
lzma_bool reserved_bool1; lzma_bool reserved_bool1;
/** \private Reserved field. */
lzma_bool reserved_bool2; lzma_bool reserved_bool2;
/** \private Reserved field. */
lzma_bool reserved_bool3; lzma_bool reserved_bool3;
/** \private Reserved field. */
lzma_bool reserved_bool4; lzma_bool reserved_bool4;
/** \private Reserved field. */
lzma_bool reserved_bool5; lzma_bool reserved_bool5;
/** \private Reserved field. */
lzma_bool reserved_bool6; lzma_bool reserved_bool6;
/** \private Reserved field. */
lzma_bool reserved_bool7; lzma_bool reserved_bool7;
/** \private Reserved field. */
lzma_bool reserved_bool8; lzma_bool reserved_bool8;
/** \private Reserved field. */
uint32_t reserved_int1; uint32_t reserved_int1;
/** \private Reserved field. */
uint32_t reserved_int2; uint32_t reserved_int2;
} lzma_stream_flags; } lzma_stream_flags;