diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2018-03-01 12:40:21 +0100 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@qt.io> | 2018-04-11 07:19:12 +0000 |
| commit | b36bf0b3eaa026e22a87865e106f54be6b520811 (patch) | |
| tree | 61b10cdf1634851820465ffbf6724e9be6d7f071 /src/androidextras/doc/qtandroidextras.qdocconf | |
| parent | a2157a9dd2ee4ed3e998654595544dadaf129fe8 (diff) | |
Doc: Fix documentation issues when using Clang-enabled QDocv5.11.0-beta4
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 <martin.smith@qt.io>
Diffstat (limited to 'src/androidextras/doc/qtandroidextras.qdocconf')
| -rw-r--r-- | src/androidextras/doc/qtandroidextras.qdocconf | 10 |
1 files changed, 10 insertions, 0 deletions
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 |