diff options
| author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2018-03-23 13:38:13 +0100 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2018-03-23 12:48:32 +0000 |
| commit | bab7fcbf40aad405666316ca55aa7e2e2925ed63 (patch) | |
| tree | 6e66da5876c50d3ada701f33f294f3d1b79ff0d0 | |
| parent | cafc667278c30659011c8e317ba42375fac073e9 (diff) | |
Doc: Fix documentation build to work with Clang-enabled QDocv5.11.0-beta3
Specifies include paths required for Clang to parse the docs.
Change-Id: Iaca12c116a665fd34114cc3ae56cf5ad60f347a6
Reviewed-by: Martin Smith <martin.smith@qt.io>
| -rw-r--r-- | src/knx/QtKnx_pch.h | 43 | ||||
| -rw-r--r-- | src/knx/doc/qtknx.qdocconf | 4 |
2 files changed, 47 insertions, 0 deletions
diff --git a/src/knx/QtKnx_pch.h b/src/knx/QtKnx_pch.h new file mode 100644 index 0000000..ab65cd8 --- /dev/null +++ b/src/knx/QtKnx_pch.h @@ -0,0 +1,43 @@ +/**************************************************************************** +** +** Copyright (C) 2018 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the QtWebEngine module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 3 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL3 included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 3 requirements +** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 2.0 or (at your option) the GNU General +** Public license version 3 or any later version approved by the KDE Free +** Qt Foundation. The licenses are as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 +** included in the packaging of this file. Please review the following +** information to ensure the GNU General Public License requirements will +** be met: https://www.gnu.org/licenses/gpl-2.0.html and +** https://www.gnu.org/licenses/gpl-3.0.html. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +// Module header file used for documentation builds only. +#ifdef Q_CLANG_QDOC +#include <QtKnx> +#endif // Q_CLANG_QDOC diff --git a/src/knx/doc/qtknx.qdocconf b/src/knx/doc/qtknx.qdocconf index f003e89..64deeb8 100644 --- a/src/knx/doc/qtknx.qdocconf +++ b/src/knx/doc/qtknx.qdocconf @@ -35,11 +35,15 @@ sourcedirs += .. exampledirs = ../../../examples/knx imagedirs += images excludedirs += ../qt4support +moduleheader = QtKnx Cpp.ignoretokens += Q_KNX_EXPORT depends += qtcore qtdoc qtnetwork qmake +# Custom module header for Clang doc builds +moduleheader = QtKnx_pch.h + #add generic thumbnail images for example documentation that does not have an image. manifestmeta.thumbnail.names += "QtKnx/Discoverer*" \ "QtKnx/Tunnel Client*" |