diff options
| author | Lasse Collin <lasse.collin@tukaani.org> | 2010-11-15 14:28:26 +0200 |
|---|---|---|
| committer | Lasse Collin <lasse.collin@tukaani.org> | 2010-11-15 14:28:26 +0200 |
| commit | 3e564704bc6f463cb2db11e3f3f0dbd71d85992e (patch) | |
| tree | 2b3bab9e812b09293f94104e9e58797cc5abac3d /src/liblzma/api/lzma | |
| parent | Simplify paths in generated API docs (diff) | |
| download | xz-3e564704bc6f463cb2db11e3f3f0dbd71d85992e.tar.xz | |
liblzma: Document the return value of lzma_lzma_preset().
Diffstat (limited to 'src/liblzma/api/lzma')
| -rw-r--r-- | src/liblzma/api/lzma/lzma.h | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/src/liblzma/api/lzma/lzma.h b/src/liblzma/api/lzma/lzma.h index 8d5fdb6e..3f8e095f 100644 --- a/src/liblzma/api/lzma/lzma.h +++ b/src/liblzma/api/lzma/lzma.h @@ -412,6 +412,9 @@ typedef struct { * * This function is available only if LZMA1 or LZMA2 encoder has been enabled * 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( lzma_options_lzma *options, uint32_t preset) lzma_nothrow; |