From bc34e5ac9996667d2c1ec9a7895ec5931ac4caea Mon Sep 17 00:00:00 2001 From: Lasse Collin Date: Thu, 16 Feb 2023 21:09:00 +0200 Subject: liblzma: Very minor API doc tweaks. Use "member" to refer to struct members as that's the term used by the C standard. Use lzma_options_delta.dist and such in docs so that in Doxygen's HTML output they will link to the doc of the struct member. Clean up a few trailing white spaces too. --- src/liblzma/api/lzma/index.h | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'src/liblzma/api/lzma/index.h') diff --git a/src/liblzma/api/lzma/index.h b/src/liblzma/api/lzma/index.h index 73bad8c1..f7de84b5 100644 --- a/src/liblzma/api/lzma/index.h +++ b/src/liblzma/api/lzma/index.h @@ -235,7 +235,7 @@ typedef struct { const void *reserved_ptr4; } block; - /** + /** * \private Internal struct. * * Internal data which is used to store the state of the iterator. @@ -243,13 +243,13 @@ typedef struct { * touch these in any way. */ union { - /** \private Internal field. */ + /** \private Internal member. */ const void *p; - /** \private Internal field. */ + /** \private Internal member. */ size_t s; - /** \private Internal field. */ + /** \private Internal member. */ lzma_vli v; } internal[6]; } lzma_index_iter; @@ -505,7 +505,7 @@ extern LZMA_API(lzma_vli) lzma_index_size(const lzma_index *i) * If multiple lzma_indexes have been combined, this works as if the Blocks * were in a single Stream. This is useful if you are going to combine * Blocks from multiple Streams into a single new Stream. - * + * * \param i Pointer to lzma_index structure * * \return Size in bytes of the Stream (if all Blocks are combined -- cgit v1.2.3