From 2964d8d691ed92abdcf214888d79ad6d79774735 Mon Sep 17 00:00:00 2001 From: Jonathan Nieder Date: Fri, 12 Nov 2010 15:22:13 -0600 Subject: [PATCH 1/2] Simplify paths in generated API docs Currently the file list generated by Doxygen has src/ at the beginning of each path. Paths like common/sysdefs.h and liblzma/api/lzma.h are easier to read without such a prefix. Builds from a separate build directory with mkdir build cd build ../configure doxygen Doxyfile include an even longer prefix /home/someone/src/xz/src; this patch has the nice side-effect of eliminating that prefix, too. Fixes: http://bugs.debian.org/572273 --- Doxyfile.in | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 From 3e564704bc6f463cb2db11e3f3f0dbd71d85992e Mon Sep 17 00:00:00 2001 From: Lasse Collin Date: Mon, 15 Nov 2010 14:28:26 +0200 Subject: [PATCH 2/2] liblzma: Document the return value of lzma_lzma_preset(). --- src/liblzma/api/lzma/lzma.h | 3 +++ 1 file changed, 3 insertions(+) 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;