Rework doxygen build and install to work with srcdir != builddir

The documentation generation with doxygen now works when built out of tree,
with srcdir != builddir.  xcb.doxygen now gets generated from xcb.doxygen.in,
so that it can use top_builddir and top_srcdir to find source and to output
documentation.  Also fill in PROJECT_NUMBER from @VERSION@, now that we have
it readily available via autoconf.

diff --git a/Makefile.am b/Makefile.am
index 65edce1..e399ae0 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -48,5 +48,4 @@ xcb-xfixes.pc.in \
 xcb-xprint.pc.in \
 xcb-xtest.pc.in \
 xcb-xv.pc.in \
-xcb-xvmc.pc.in \
-xcb.doxygen
+xcb-xvmc.pc.in

diff --git a/configure.ac b/configure.ac
index 0dd396d..0d2a11f 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -84,5 +84,6 @@ AM_CHECK_DOXYGEN()
 
 AC_CONFIG_FILES([Makefile src/Makefile tests/Makefile doc/Makefile])
 AC_CONFIG_FILES([xcb.pc xcb-xlib.pc xcb-composite.pc xcb-damage.pc xcb-dpms.pc xcb-glx.pc xcb-randr.pc xcb-record.pc xcb-render.pc xcb-res.pc xcb-screensaver.pc xcb-shape.pc xcb-shm.pc xcb-sync.pc xcb-xevie.pc xcb-xf86dri.pc xcb-xfixes.pc xcb-xinerama.pc xcb-xprint.pc xcb-xtest.pc xcb-xv.pc xcb-xvmc.pc])
+AC_CONFIG_FILES([doc/xcb.doxygen])
 
 AC_OUTPUT

diff --git a/doc/.gitignore b/doc/.gitignore
index 2905494..94ce3a9 100644 (file)
--- a/doc/.gitignore
+++ b/doc/.gitignore
@@ -1 +1,2 @@
 manual
+xcb.doxygen
\ No newline at end of file

diff --git a/doc/Makefile.am b/doc/Makefile.am
index f46f0b1..27f492c 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,7 +1,8 @@
 
 EXTRA_DIST = \
 tutorial/index.html \
-tutorial/xcb.css
+tutorial/xcb.css \
+xcb.doxygen.in
 
 htmlDATA_INSTALL = cp -pR
 
@@ -20,7 +21,7 @@ if BUILD_DOCS
 
 # rule to build documentation and copy necessary files
 manual: clean-local
-       cd .. && doxygen xcb.doxygen
+       doxygen xcb.doxygen
 
 # rules to clean
 clean-local:

diff --git a/xcb.doxygen b/doc/xcb.doxygen.in
similarity index 99%
rename from xcb.doxygen
rename to doc/xcb.doxygen.in
index 1f4bb73..58aa076 100644 (file)
--- a/xcb.doxygen
+++ b/doc/xcb.doxygen.in
@@ -23,14 +23,14 @@ PROJECT_NAME           = "XCB"
 # This could be handy for archiving the generated documentation or
 # if some version control system is used.
 
-PROJECT_NUMBER         =
+PROJECT_NUMBER         = @VERSION@
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
 # base path where the generated documentation will be put.
 # If a relative path is entered, it will be relative to the location
 # where doxygen was started. If left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = doc
+OUTPUT_DIRECTORY       = @top_builddir@/doc
 
 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
 # 4096 sub-directories (in 2 levels) under the output directory of each output
@@ -106,7 +106,7 @@ INLINE_INHERITED_MEMB  = NO
 # path before files name in the file list and in the header files. If set
 # to NO the shortest path that makes the file name unique will be used.
 
-FULL_PATH_NAMES        = YES
+FULL_PATH_NAMES        = NO
 
 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
 # can be used to strip a user-defined part of the path. Stripping is
@@ -460,7 +460,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = src
+INPUT                  = @top_srcdir@/src @top_builddir@/src
 
 # If the value of the INPUT tag contains directories, you can use the
 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp