diff options
| author | Jia Tan <jiat0218@gmail.com> | 2023-02-06 21:45:37 +0800 |
|---|---|---|
| committer | Jia Tan <jiat0218@gmail.com> | 2023-03-07 23:24:42 +0800 |
| commit | 3971f5c5024750ce8286891c6f79ae1661047483 (patch) | |
| tree | 46b36015394f8e7618e0ebd4860f9389981758cc | |
| parent | liblzma: Reword a few lines in filter.h (diff) | |
| download | xz-3971f5c5024750ce8286891c6f79ae1661047483.tar.xz | |
liblzma: Shorten return description for two functions in filter.h.
Shorten the description for lzma_raw_encoder_memusage() and
lzma_raw_decoder_memusage().
| -rw-r--r-- | src/liblzma/api/lzma/filter.h | 8 |
1 files changed, 2 insertions, 6 deletions
diff --git a/src/liblzma/api/lzma/filter.h b/src/liblzma/api/lzma/filter.h index 30460518..d5a975fc 100644 --- a/src/liblzma/api/lzma/filter.h +++ b/src/liblzma/api/lzma/filter.h @@ -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; |