diff options
author | Jia Tan <jiat0218@gmail.com> | 2023-02-08 20:30:23 +0800 |
---|---|---|
committer | Jia Tan <jiat0218@gmail.com> | 2023-02-15 22:47:36 +0800 |
commit | 1f157d214bc09338876d2467b549935679abc0bf (patch) | |
tree | 707e1699eeede433c47bd938cc876571362f23a4 /src/liblzma/api/lzma/index.h | |
parent | liblzma: Fix documentation for LZMA_MEMLIMIT_ERROR. (diff) | |
download | xz-1f157d214bc09338876d2467b549935679abc0bf.tar.xz |
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.
Diffstat (limited to 'src/liblzma/api/lzma/index.h')
-rw-r--r-- | src/liblzma/api/lzma/index.h | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/src/liblzma/api/lzma/index.h b/src/liblzma/api/lzma/index.h index c7be9772..c349b5f7 100644 --- a/src/liblzma/api/lzma/index.h +++ b/src/liblzma/api/lzma/index.h @@ -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; |