liblzma: Document the return value of lzma_lzma_preset().

2010-11-15 14:28:26 +02:00 · 2010-11-15 14:28:26 +02:00 · 3e564704bc
parent 2964d8d691
commit 3e564704bc
1 changed files with 3 additions and 0 deletions
--- 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;