From 3f8fa53837bae8b44f3addf19923e26401336c3d Mon Sep 17 00:00:00 2001 From: Lasse Collin Date: Mon, 11 Apr 2011 21:04:13 +0300 Subject: liblzma: Document lzma_easy_(enc|dec)oder_memusage() better too. --- src/liblzma/api/lzma/container.h | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'src/liblzma/api') diff --git a/src/liblzma/api/lzma/container.h b/src/liblzma/api/lzma/container.h index 56ef774c..7a9ffc64 100644 --- a/src/liblzma/api/lzma/container.h +++ b/src/liblzma/api/lzma/container.h @@ -66,6 +66,10 @@ * This function is a wrapper for lzma_raw_encoder_memusage(). * * \param preset Compression preset (level and possible flags) + * + * \return Number of bytes of memory required for the given + * preset when encoding. If an error occurs, for example + * due to unsupported preset, UINT64_MAX is returned. */ extern LZMA_API(uint64_t) lzma_easy_encoder_memusage(uint32_t preset) lzma_nothrow lzma_attr_pure; @@ -77,6 +81,11 @@ extern LZMA_API(uint64_t) lzma_easy_encoder_memusage(uint32_t preset) * This function is a wrapper for lzma_raw_decoder_memusage(). * * \param preset Compression preset (level and possible flags) + * + * \return Number of bytes of memory required to decompress a file + * that was compressed using the given preset. If an error + * occurs, for example due to unsupported preset, UINT64_MAX + * is returned. */ extern LZMA_API(uint64_t) lzma_easy_decoder_memusage(uint32_t preset) lzma_nothrow lzma_attr_pure; -- cgit v1.2.3