Simplify paths in generated API docs
authorJonathan Nieder <jrnieder@gmail.com>
Fri, 12 Nov 2010 21:22:13 +0000 (15:22 -0600)
committerLasse Collin <lasse.collin@tukaani.org>
Sat, 13 Nov 2010 12:36:28 +0000 (14:36 +0200)
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

index fa3c1e1..386706a 100644 (file)
@@ -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