From b36bf0b3eaa026e22a87865e106f54be6b520811 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Thu, 1 Mar 2018 12:40:21 +0100 Subject: Doc: Fix documentation issues when using Clang-enabled QDoc QDoc in Qt 5.11 uses Clang to parse the C++ source for documentation comments. Unlike the old parser, Clang requires a module header to be present as well as correct include paths to generate the docs correctly. However, these are available from the build system only when building for Android, not when generating the documentation on a system with no Android-related assets. To fix this, create a 'dummy' module header specific to doc builds, add required relative include paths in .qdocconf, and fix the documentation \fn commands to work with Clang. Change-Id: Ia3d4e50ff8756cd8c8aae9cd3c3d1492eb7db328 Reviewed-by: Martin Smith --- src/androidextras/doc/qtandroidextras.qdocconf | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'src/androidextras/doc/qtandroidextras.qdocconf') diff --git a/src/androidextras/doc/qtandroidextras.qdocconf b/src/androidextras/doc/qtandroidextras.qdocconf index b42a391..bf810ad 100644 --- a/src/androidextras/doc/qtandroidextras.qdocconf +++ b/src/androidextras/doc/qtandroidextras.qdocconf @@ -1,6 +1,16 @@ include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) Cpp.ignoretokens += Q_ANDROIDEXTRAS_EXPORT +# dummy module header for clang, found under doc/ +moduleheader = QtAndroidExtrasDoc + +# pass include paths to clang +includepaths += -I . \ + -I .. \ + -I ../android \ + -I ../jni \ + -I ./QtAndroidExtras \ + -I $QT_INSTALL_HEADERS project = QtAndroidExtras description = Qt Android Extras Reference Documentation -- cgit v1.2.3