frederik
/
libxcb
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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.
This commit is contained in:
Josh Triplett 2006-11-23 00:08:30 -08:00
parent 608058ec80
commit af3a15838f
5 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Makefile.am
View File

@ -48,5 +48,4 @@ xcb-xfixes.pc.in \
xcb-xprint.pc.in \ xcb-xprint.pc.in \
xcb-xtest.pc.in \ xcb-xtest.pc.in \
xcb-xv.pc.in \ xcb-xv.pc.in \
xcb-xvmc.pc.in \ xcb-xvmc.pc.in
xcb.doxygen

1
configure.ac
View File

@ -84,5 +84,6 @@ AM_CHECK_DOXYGEN()
AC_CONFIG_FILES([Makefile src/Makefile tests/Makefile doc/Makefile]) 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([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 AC_OUTPUT

1
doc/.gitignore vendored
View File

@ -1 +1,2 @@
manual manual
xcb.doxygen

5
doc/Makefile.am
View File

@ -1,7 +1,8 @@
EXTRA_DIST = \ EXTRA_DIST = \
tutorial/index.html \ tutorial/index.html \
tutorial/xcb.css tutorial/xcb.css \
xcb.doxygen.in
htmlDATA_INSTALL = cp -pR htmlDATA_INSTALL = cp -pR
@ -20,7 +21,7 @@ if BUILD_DOCS
# rule to build documentation and copy necessary files # rule to build documentation and copy necessary files
manual: clean-local manual: clean-local
cd .. && doxygen xcb.doxygen doxygen xcb.doxygen
# rules to clean # rules to clean
clean-local: clean-local:

8
xcb.doxygen → doc/xcb.doxygen.in
View File

@ -23,14 +23,14 @@ PROJECT_NAME = "XCB"
# This could be handy for archiving the generated documentation or # This could be handy for archiving the generated documentation or
# if some version control system is used. # if some version control system is used.
PROJECT_NUMBER = PROJECT_NUMBER = @VERSION@
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put. # base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location # 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. # 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 # 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 # 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 # 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. # 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 # 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 # 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 # directories like "/usr/src/myproject". Separate the files or directories
# with spaces. # with spaces.
INPUT = src INPUT = @top_srcdir@/src @top_builddir@/src
# If the value of the INPUT tag contains directories, you can use the # 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 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp