StreetLight
/
libxkbcommon
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Fix Doxygen include for srcdir != builddir 

Instead of giving Doxygen a series of absolute paths to the source
files and a relative path to the output directory, run it from the
source directory with purely relative paths to the source files, and
give it an absolute path to the build directory.

This fixes the parsing of README.md with a separate build directory,
since the relative includes for doc/quick-guide.md and doc/compat.md
don't resolve otherwise. Doxygen's INCLUDE_PATH turns out not to fix
this either, since that's just a set of paths to open and parse, rather
than an analogue to cpp's -I.

Signed-off-by: Daniel Stone <daniels@collabora.com>
master
Daniel Stone 2016-03-15 11:20:35 +00:00
parent d627549c61
commit a2974d5f8a
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile.am
View File

@ -151,7 +151,7 @@ all-local:: doc
clean-local:: clean-doc
doc/stamp-doxygen: $(top_srcdir)/xkbcommon/*.h
$(AM_V_GEN)$(DOXYGEN) doc/Doxyfile
$(AM_V_GEN)(cd $(top_srcdir) && $(DOXYGEN) $(abs_top_builddir)/doc/Doxyfile)
touch $@
clean-doxygen:

18
doc/Doxyfile.in
View File

@ -2,7 +2,7 @@ PROJECT_NAME = @PACKAGE_NAME@
PROJECT_NUMBER = @PACKAGE_VERSION@
OUTPUT_DIRECTORY = doc
OUTPUT_DIRECTORY = @abs_top_builddir@/doc
BRIEF_MEMBER_DESC = NO
@ -18,13 +18,13 @@ QUIET = YES
WARN_IF_UNDOCUMENTED = NO
INPUT = @abs_top_srcdir@/README.md \
@abs_top_srcdir@/doc/quick-guide.md \
@abs_top_srcdir@/doc/compat.md \
@abs_top_srcdir@/xkbcommon/xkbcommon.h \
@abs_top_srcdir@/xkbcommon/xkbcommon-names.h \
@abs_top_srcdir@/xkbcommon/xkbcommon-x11.h \
@abs_top_srcdir@/xkbcommon/xkbcommon-compose.h \
INPUT = README.md \
doc/quick-guide.md \
doc/compat.md \
xkbcommon/xkbcommon.h \
xkbcommon/xkbcommon-names.h \
xkbcommon/xkbcommon-x11.h \
xkbcommon/xkbcommon-compose.h \
FILE_PATTERNS = *.c \
*.h
@ -40,7 +40,7 @@ ALPHABETICAL_INDEX = NO
IGNORE_PREFIX = xkb_ \
XKB_
HTML_EXTRA_STYLESHEET = @abs_top_srcdir@/doc/doxygen-extra.css
HTML_EXTRA_STYLESHEET = doc/doxygen-extra.css
HTML_TIMESTAMP = NO