aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLasse Collin <lasse.collin@tukaani.org>2010-11-15 14:33:01 +0200
committerLasse Collin <lasse.collin@tukaani.org>2010-11-15 14:33:01 +0200
commit7c24e0d1b8a2e86e9263b0d56d39621e01aed7af (patch)
tree6347dd642bef2643c0f13c986068bf93c6f263ec
parentadd build script for macosx universal (diff)
parentliblzma: Document the return value of lzma_lzma_preset(). (diff)
downloadxz-7c24e0d1b8a2e86e9263b0d56d39621e01aed7af.tar.xz
Merge branch 'v5.0'
-rw-r--r--Doxyfile.in2
-rw-r--r--src/liblzma/api/lzma/lzma.h3
2 files changed, 4 insertions, 1 deletions
diff --git a/Doxyfile.in b/Doxyfile.in
index fa3c1e1d..386706ab 100644
--- a/Doxyfile.in
+++ b/Doxyfile.in
@@ -118,7 +118,7 @@ FULL_PATH_NAMES = YES
# If left blank the directory from which doxygen is run is used as the
# path to strip.
-STRIP_FROM_PATH =
+STRIP_FROM_PATH = @top_srcdir@/src
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
# the path mentioned in the documentation of a class, which tells
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;