From: Lasse Collin <lasse.collin@tukaani.org>
Date: Mon, 15 Nov 2010 12:28:26 +0000 (+0200)
Subject: liblzma: Document the return value of lzma_lzma_preset().
X-Git-Tag: v5.0.1~11
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3e564704bc6f463cb2db11e3f3f0dbd71d85992e;p=thirdparty%2Fxz.git

liblzma: Document the return value of lzma_lzma_preset().
---

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;