revi-archive/xz-archive
1
0
Fork 0
mirror of https://git.tukaani.org/xz.git synced 2024-04-04 12:36:23 +02:00
Code Activity

liblzma: Adjust container.h for consistency with filter.h.

Browse source
This commit is contained in:
Jia Tan 2023-02-07 00:00:44 +08:00
parent 00a721b63d
commit fa9065fac5
1 changed files with 9 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
src/liblzma/api/lzma/container.h
View file

@ -267,8 +267,7 @@ typedef struct {
* \param preset Compression preset (level and possible flags) * \param preset Compression preset (level and possible flags)
* *
* \return Number of bytes of memory required for the given * \return Number of bytes of memory required for the given
* preset when encoding. If an error occurs, for example * preset when encoding or UINT64_MAX on error.
* due to unsupported preset, UINT64_MAX is returned.
*/ */
extern LZMA_API(uint64_t) lzma_easy_encoder_memusage(uint32_t preset) extern LZMA_API(uint64_t) lzma_easy_encoder_memusage(uint32_t preset)
lzma_nothrow lzma_attr_pure; lzma_nothrow lzma_attr_pure;
@ -282,9 +281,8 @@ extern LZMA_API(uint64_t) lzma_easy_encoder_memusage(uint32_t preset)
* \param preset Compression preset (level and possible flags) * \param preset Compression preset (level and possible flags)
* *
* \return Number of bytes of memory required to decompress a file * \return Number of bytes of memory required to decompress a file
* that was compressed using the given preset. If an error * that was compressed using the given preset or UINT64_MAX
* occurs, for example due to unsupported preset, UINT64_MAX * on error.
* is returned.
*/ */
extern LZMA_API(uint64_t) lzma_easy_decoder_memusage(uint32_t preset) extern LZMA_API(uint64_t) lzma_easy_decoder_memusage(uint32_t preset)
lzma_nothrow lzma_attr_pure; lzma_nothrow lzma_attr_pure;
@ -376,9 +374,9 @@ extern LZMA_API(lzma_ret) lzma_easy_buffer_encode(
* *
* \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 filters Array of filters. This must be terminated with * \param filters Array of filters terminated with
* filters[n].id = LZMA_VLI_UNKNOWN. See filter.h for * .id == LZMA_VLI_UNKNOWN. See filters.h for more
* more information. * information.
* \param check Type of the integrity check to calculate from * \param check Type of the integrity check to calculate from
* uncompressed data. * uncompressed data.
* *
@ -503,9 +501,9 @@ extern LZMA_API(size_t) lzma_stream_buffer_bound(size_t uncompressed_size)
/** /**
* \brief Single-call .xz Stream encoder * \brief Single-call .xz Stream encoder
* *
* \param filters Array of filters. This must be terminated with * \param filters Array of filters terminated with
* filters[n].id = LZMA_VLI_UNKNOWN. See filter.h * .id == LZMA_VLI_UNKNOWN. See filters.h for more
* for more information. * information.
* \param check Type of the integrity check to calculate from * \param check Type of the integrity check to calculate from
* uncompressed data. * uncompressed data.
* \param allocator lzma_allocator for custom allocator functions. * \param allocator lzma_allocator for custom allocator functions.