]> git.ipfire.org Git - thirdparty/xz.git/commitdiff
liblzma: Shorten return description for two functions in filter.h.
authorJia Tan <jiat0218@gmail.com>
Mon, 6 Feb 2023 13:45:37 +0000 (21:45 +0800)
committerJia Tan <jiat0218@gmail.com>
Tue, 7 Mar 2023 15:24:42 +0000 (23:24 +0800)
Shorten the description for lzma_raw_encoder_memusage() and
lzma_raw_decoder_memusage().

src/liblzma/api/lzma/filter.h

index 304605188a6e8f2a5ca6a5c29c8d9c05ae760d6e..d5a975fcafb55ef1fc0f044ddce8016025b43cc5 100644 (file)
@@ -173,9 +173,7 @@ extern LZMA_API(void) lzma_filters_free(
  *                          .id == LZMA_VLI_UNKNOWN.
  *
  * \return      Number of bytes of memory required for the given
- *              filter chain when encoding. If an error occurs,
- *              for example due to unsupported filter chain,
- *              UINT64_MAX is returned.
+ *              filter chain when encoding or UINT64_MAX on error.
  */
 extern LZMA_API(uint64_t) lzma_raw_encoder_memusage(const lzma_filter *filters)
                lzma_nothrow lzma_attr_pure;
@@ -192,9 +190,7 @@ extern LZMA_API(uint64_t) lzma_raw_encoder_memusage(const lzma_filter *filters)
  *                          .id == LZMA_VLI_UNKNOWN.
  *
  * \return      Number of bytes of memory required for the given
- *              filter chain when decoding. If an error occurs,
- *              for example due to unsupported filter chain,
- *              UINT64_MAX is returned.
+ *              filter chain when decoding or UINT64_MAX on error.
  */
 extern LZMA_API(uint64_t) lzma_raw_decoder_memusage(const lzma_filter *filters)
                lzma_nothrow lzma_attr_pure;