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 d15eb46891
commit cf3780e309
3 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/liblzma/api/lzma/container.h
View File

@ -765,7 +765,7 @@ extern LZMA_API(lzma_ret) lzma_stream_decoder_mt(
* as it doesn't support any decoder flags. It will return LZMA_STREAM_END * as it doesn't support any decoder flags. It will return LZMA_STREAM_END
* after one .lzma stream.) * after one .lzma stream.)
* *
* \param strm Pointer to lzma_stream that is at least initialized * \param strm Pointer to lzma_stream that is at least initialized
* with LZMA_STREAM_INIT. * with LZMA_STREAM_INIT.
* \param memlimit Memory usage limit as bytes. Use UINT64_MAX * \param memlimit Memory usage limit as bytes. Use UINT64_MAX
* to effectively disable the limiter. liblzma * to effectively disable the limiter. liblzma

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

@ -234,7 +234,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
@ -651,7 +651,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:
@ -771,7 +771,7 @@ extern LZMA_API(lzma_ret) lzma_index_buffer_encode(const lzma_index *i,
* lzma_index is allowed to require. The value * lzma_index is allowed to require. The value
* pointed by this pointer is modified if and only * pointed by this pointer is modified if and only
* if LZMA_MEMLIMIT_ERROR is returned. * if LZMA_MEMLIMIT_ERROR is returned.
* \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().
* \param in Beginning of the input buffer * \param in Beginning of the input buffer
* \param in_pos The next byte will be read from in[*in_pos]. * \param in_pos The next byte will be read from in[*in_pos].

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

@ -68,9 +68,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)