Document how to use CMake for Qt DBus

Task-number: QTBUG-73058
Change-Id: Ibe0779d109682cc41e21783a3ba5fa5130d5ff7f
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
bb10
Kai Koehne 2020-05-22 10:32:02 +02:00
parent 162ea888bf
commit 1c0ca1f3d8
7 changed files with 21 additions and 77 deletions

View File

@ -10,8 +10,9 @@ project = QtDBus
# Images should be placed in <rootdir>/dic/images and examples in
# <rootdir>/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

View File

@ -0,0 +1,4 @@
#! [cmake_use]
find_package(Qt6 COMPONENTS DBus REQUIRED)
target_link_libraries(mytarget Qt::DBus)
#! [cmake_use]

View File

@ -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 <QtDBus>
//! [0]

View File

@ -1,3 +0,0 @@
#! [1]
QT += dbus
#! [1]

View File

@ -0,0 +1,3 @@
#! [qmake_use]
QT += dbus
#! [qmake_use]

View File

@ -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

View File

@ -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.
*/