liblzma: Document the return value of lzma_lzma_preset(). origin/v5.0
authorLasse Collin <lasse.collin@tukaani.org>
Mon, 15 Nov 2010 12:28:26 +0000 (14:28 +0200)
committerLasse Collin <lasse.collin@tukaani.org>
Mon, 15 Nov 2010 12:28:26 +0000 (14:28 +0200)
src/liblzma/api/lzma/lzma.h

index 8d5fdb6..3f8e095 100644 (file)
@@ -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;