liblzma: Omit lzma_index_iter's internal field from Doxygen docs.

Add \private above this field and its sub-fields since it is not meant
to be modified by users.
This commit is contained in:
Jia Tan 2023-02-08 20:30:23 +08:00
parent 0c9e4fc2ad
commit b675394849
1 changed files with 8 additions and 1 deletions
src/liblzma/api/lzma

View File

@ -235,14 +235,21 @@ typedef struct {
const void *reserved_ptr4;
} block;
/*
/**
* \private Internal struct.
*
* Internal data which is used to store the state of the iterator.
* The exact format may vary between liblzma versions, so don't
* touch these in any way.
*/
union {
/** \private Internal field. */
const void *p;
/** \private Internal field. */
size_t s;
/** \private Internal field. */
lzma_vli v;
} internal[6];
} lzma_index_iter;