From 1c0ca1f3d840b3ae4f5d11f8657ea0680915ab68 Mon Sep 17 00:00:00 2001 From: Kai Koehne Date: Fri, 22 May 2020 10:32:02 +0200 Subject: Document how to use CMake for Qt DBus Task-number: QTBUG-73058 Change-Id: Ibe0779d109682cc41e21783a3ba5fa5130d5ff7f Reviewed-by: Paul Wicking --- src/dbus/doc/qtdbus.qdocconf | 7 ++-- src/dbus/doc/snippets/CMakeLists.txt | 4 ++ src/dbus/doc/snippets/code/doc_src_qtdbus.cpp | 53 --------------------------- src/dbus/doc/snippets/code/doc_src_qtdbus.pro | 3 -- src/dbus/doc/snippets/snippets.pro | 3 ++ src/dbus/doc/src/qtdbus-index.qdoc | 10 ++++- src/dbus/doc/src/qtdbus-module.qdoc | 18 +-------- 7 files changed, 21 insertions(+), 77 deletions(-) create mode 100644 src/dbus/doc/snippets/CMakeLists.txt delete mode 100644 src/dbus/doc/snippets/code/doc_src_qtdbus.cpp delete mode 100644 src/dbus/doc/snippets/code/doc_src_qtdbus.pro create mode 100644 src/dbus/doc/snippets/snippets.pro (limited to 'src/dbus') diff --git a/src/dbus/doc/qtdbus.qdocconf b/src/dbus/doc/qtdbus.qdocconf index e08bbfd94e..e88f39ce86 100644 --- a/src/dbus/doc/qtdbus.qdocconf +++ b/src/dbus/doc/qtdbus.qdocconf @@ -10,8 +10,9 @@ project = QtDBus # Images should be placed in /dic/images and examples in # /examples. # Paths are relative to the location of this file. -exampledirs += ../../../examples/dbus \ - snippets +exampledirs += . \ + snippets \ + ../../../examples/dbus headerdirs += .. imagedirs += images \ @@ -24,7 +25,7 @@ examplesinstallpath = dbus tagfile = qtdbus.tags -depends += qtdoc qtcore +depends += qtcore qtdoc qmake qtcmake # The following parameters are for creating a qhp file, the qhelpgenerator # program can convert the qhp file into a qch file which can be opened in diff --git a/src/dbus/doc/snippets/CMakeLists.txt b/src/dbus/doc/snippets/CMakeLists.txt new file mode 100644 index 0000000000..c9f398a22f --- /dev/null +++ b/src/dbus/doc/snippets/CMakeLists.txt @@ -0,0 +1,4 @@ +#! [cmake_use] +find_package(Qt6 COMPONENTS DBus REQUIRED) +target_link_libraries(mytarget Qt::DBus) +#! [cmake_use] diff --git a/src/dbus/doc/snippets/code/doc_src_qtdbus.cpp b/src/dbus/doc/snippets/code/doc_src_qtdbus.cpp deleted file mode 100644 index 444561267d..0000000000 --- a/src/dbus/doc/snippets/code/doc_src_qtdbus.cpp +++ /dev/null @@ -1,53 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:BSD$ -** 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. -** -** BSD License Usage -** Alternatively, you may use this file under the terms of the BSD license -** as follows: -** -** "Redistribution and use in source and binary forms, with or without -** modification, are permitted provided that the following conditions are -** met: -** * Redistributions of source code must retain the above copyright -** notice, this list of conditions and the following disclaimer. -** * Redistributions in binary form must reproduce the above copyright -** notice, this list of conditions and the following disclaimer in -** the documentation and/or other materials provided with the -** distribution. -** * Neither the name of The Qt Company Ltd nor the names of its -** contributors may be used to endorse or promote products derived -** from this software without specific prior written permission. -** -** -** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -//! [0] -#include -//! [0] diff --git a/src/dbus/doc/snippets/code/doc_src_qtdbus.pro b/src/dbus/doc/snippets/code/doc_src_qtdbus.pro deleted file mode 100644 index a1ba138a85..0000000000 --- a/src/dbus/doc/snippets/code/doc_src_qtdbus.pro +++ /dev/null @@ -1,3 +0,0 @@ -#! [1] -QT += dbus -#! [1] diff --git a/src/dbus/doc/snippets/snippets.pro b/src/dbus/doc/snippets/snippets.pro new file mode 100644 index 0000000000..6c3b57fec9 --- /dev/null +++ b/src/dbus/doc/snippets/snippets.pro @@ -0,0 +1,3 @@ +#! [qmake_use] +QT += dbus +#! [qmake_use] diff --git a/src/dbus/doc/src/qtdbus-index.qdoc b/src/dbus/doc/src/qtdbus-index.qdoc index 0cda4d2a8d..1023022a1d 100644 --- a/src/dbus/doc/src/qtdbus-index.qdoc +++ b/src/dbus/doc/src/qtdbus-index.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the documentation of the Qt Toolkit. @@ -32,6 +32,14 @@ \keyword QtDBus + \include module-use.qdocinc using qt module + \snippet snippets/CMakeLists.txt cmake_use + + See also the \l[QtDoc]{Building with CMake} overview. + + \include module-use.qdocinc building with qmake + \snippet snippets/snippets.pro qmake_use + \section1 Introduction D-Bus is an Inter-Process Communication (IPC) and Remote Procedure diff --git a/src/dbus/doc/src/qtdbus-module.qdoc b/src/dbus/doc/src/qtdbus-module.qdoc index 0ef5999b11..a1abfaa24b 100644 --- a/src/dbus/doc/src/qtdbus-module.qdoc +++ b/src/dbus/doc/src/qtdbus-module.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the documentation of the Qt Toolkit. @@ -47,22 +47,6 @@ to connect to a signal emitted remotely as well as to connect a local signal to remote slot. - To use this module, use the following code in your application: - - \snippet code/doc_src_qtdbus.cpp 0 - - \if !defined(qtforpython) - If you're using qmake to build your application, you can add this - line to your .pro file to make it link against the Qt D-Bus - libraries: - - \snippet code/doc_src_qtdbus.pro 1 - - \note The source code for this module is located in the \c{src/qdbus} - directory. When installing Qt from source, this module is built when Qt's - tools are built. - \endif - See the \l {Qt D-Bus}{D-Bus} page for detailed information on how to use this module. */ -- cgit v1.2.3