liblzma: Document the return value of lzma_lzma_preset().

This commit is contained in:
Lasse Collin 2010-11-15 14:28:26 +02:00
parent 2964d8d691
commit 3e564704bc
1 changed files with 3 additions and 0 deletions

View File

@ -412,6 +412,9 @@ typedef struct {
* *
* This function is available only if LZMA1 or LZMA2 encoder has been enabled * This function is available only if LZMA1 or LZMA2 encoder has been enabled
* when building liblzma. * when building liblzma.
*
* \return On success, false is returned. If the preset is not
* supported, true is returned.
*/ */
extern LZMA_API(lzma_bool) lzma_lzma_preset( extern LZMA_API(lzma_bool) lzma_lzma_preset(
lzma_options_lzma *options, uint32_t preset) lzma_nothrow; lzma_options_lzma *options, uint32_t preset) lzma_nothrow;