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

liblzma: API doc cleanups 

(cherry picked from commit 08ab0966a7)
This commit is contained in:
Lasse Collin 2024-04-24 01:20:26 +03:00
parent 94a462850b
commit 0ca14871f3
3 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -233,7 +233,7 @@ typedef struct {
} block; } block;
/** /**
* \private Internal struct. * \private Internal data
* *
* Internal data which is used to store the state of the iterator. * Internal data which is used to store the state of the iterator.
* The exact format may vary between liblzma versions, so don't * The exact format may vary between liblzma versions, so don't
@ -673,7 +673,7 @@ extern LZMA_API(lzma_bool) lzma_index_iter_locate(
* function succeeds, the memory allocated for src * function succeeds, the memory allocated for src
* is freed or moved to be part of dest, and all * is freed or moved to be part of dest, and all
* iterators pointing to src will become invalid. * iterators pointing to src will become invalid.
* \param allocator lzma_allocator for custom allocator functions. * \param allocator lzma_allocator for custom allocator functions.
* Set to NULL to use malloc() and free(). * Set to NULL to use malloc() and free().
* *
* \return Possible lzma_ret values: * \return Possible lzma_ret values:

5
src/liblzma/api/lzma/vli.h
View File

@ -67,9 +67,8 @@ typedef uint64_t lzma_vli;
* This is useful to test that application has given acceptable values * This is useful to test that application has given acceptable values
* for example in the uncompressed_size and compressed_size variables. * for example in the uncompressed_size and compressed_size variables.
* *
* \return True if the integer is representable as VLI or if it * \return True if the integer is representable as a VLI or if it
* indicates unknown value. False if the integer cannot be * indicates an unknown value. False otherwise.
* represented as VLI.
*/ */
#define lzma_vli_is_valid(vli) \ #define lzma_vli_is_valid(vli) \
((vli) <= LZMA_VLI_MAX || (vli) == LZMA_VLI_UNKNOWN) ((vli) <= LZMA_VLI_MAX || (vli) == LZMA_VLI_UNKNOWN)