diff options
author | Andreas Buhr <andreas.buhr@qt.io> | 2021-08-18 11:07:04 +0200 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2021-08-19 09:14:26 +0000 |
commit | 6a18a6c777299bcc65b91be70d0c8c1947034d1a (patch) | |
tree | 07bb29c5375226c28c0123e2867021c6b993cf3b /src | |
parent | 927bd2d2935cf6342b7f1a8778484c258da33063 (diff) |
Remove documentation of previously removed Qt Bluetooth QML types
The QML interface to Qt Bluetooth was removed. This patch
removes some remainders in the documentation.
Task-number: QTBUG-94894
Change-Id: I4e4d0ae354ccc1b88aa8530b89e6786752b8af49
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Oliver Wolff <oliver.wolff@qt.io>
(cherry picked from commit 77c628bc7c7025361abce4a01496434e42bc21e5)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'src')
-rw-r--r-- | src/bluetooth/doc/qtbluetooth.qdocconf | 7 | ||||
-rw-r--r-- | src/bluetooth/doc/snippets/doc_src_qtbluetooth.qml | 78 | ||||
-rw-r--r-- | src/bluetooth/doc/src/bluetooth-index.qdoc | 9 | ||||
-rw-r--r-- | src/bluetooth/doc/src/bluetooth-qml.qdoc | 48 |
4 files changed, 1 insertions, 141 deletions
diff --git a/src/bluetooth/doc/qtbluetooth.qdocconf b/src/bluetooth/doc/qtbluetooth.qdocconf index 05a5bc9b..05e24abb 100644 --- a/src/bluetooth/doc/qtbluetooth.qdocconf +++ b/src/bluetooth/doc/qtbluetooth.qdocconf @@ -18,15 +18,11 @@ qhp.QtBluetooth.indexRoot = qhp.QtBluetooth.filterAttributes = qtbluetooth $QT_VERSION qtrefdoc qhp.QtBluetooth.customFilters.Qt.name = QtBluetooth $QT_VERSION qhp.QtBluetooth.customFilters.Qt.filterAttributes = qtbluetooth $QT_VERSION -qhp.QtBluetooth.subprojects = overviews classes qml examples +qhp.QtBluetooth.subprojects = overviews classes examples qhp.QtBluetooth.subprojects.classes.title = C++ Classes qhp.QtBluetooth.subprojects.classes.indexTitle = Qt Bluetooth C++ Classes qhp.QtBluetooth.subprojects.classes.selectors = class fake:headerfile qhp.QtBluetooth.subprojects.classes.sortPages = true -qhp.QtBluetooth.subprojects.qml.title = QML Types -qhp.QtBluetooth.subprojects.qml.indexTitle = Qt Bluetooth QML Types -qhp.QtBluetooth.subprojects.qml.selectors = fake:headerfile -qhp.QtBluetooth.subprojects.qml.sortPages = true qhp.QtBluetooth.subprojects.overviews.title = Overviews qhp.QtBluetooth.subprojects.overviews.indexTitle = Qt Bluetooth Overview qhp.QtBluetooth.subprojects.overviews.selectors = fake:page,group,module @@ -53,4 +49,3 @@ imagedirs += images navigation.landingpage = "Qt Bluetooth" navigation.cppclassespage = "Qt Bluetooth C++ Classes" -navigation.qmltypespage = "Qt Bluetooth QML Types" diff --git a/src/bluetooth/doc/snippets/doc_src_qtbluetooth.qml b/src/bluetooth/doc/snippets/doc_src_qtbluetooth.qml deleted file mode 100644 index 8508a9e4..00000000 --- a/src/bluetooth/doc/snippets/doc_src_qtbluetooth.qml +++ /dev/null @@ -1,78 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2017 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$ -** -****************************************************************************/ - -//! [import] -import QtBluetooth 5.12 -//! [import] - -//! [service] - // The socket via which communication to remote host happens - BluetoothSocket { - id: bluetoothSocket - - onConnectedChanged: { - console.log("bluetoothSocket status: " + connected) - if (connected) { - titleRow.title = "Connected"; - - // Send some data to the remote device - stringData = "Hello there!"; - - } else { - titleRow.title = "Disconnected"; - } - } - - // read incoming data from the remote device - onDataAvailable: { - print("received data:", stringData); - } - } -//! [service] diff --git a/src/bluetooth/doc/src/bluetooth-index.qdoc b/src/bluetooth/doc/src/bluetooth-index.qdoc index f71f015e..a5adae55 100644 --- a/src/bluetooth/doc/src/bluetooth-index.qdoc +++ b/src/bluetooth/doc/src/bluetooth-index.qdoc @@ -102,11 +102,6 @@ option to your \c .pro file: \snippet snippets.pro contacts project modification -To use the classes of the module in your application you need the following -import statement in your \c .qml file: - -\snippet doc_src_qtbluetooth.qml import - \section1 Related Information \section2 Building Qt Bluetooth @@ -130,7 +125,6 @@ The usage of the dummy backend is highlighted via an appropriate warning while b \section2 Reference \list - \li \l {Qt Bluetooth QML Types}{QML Types} \li \l {Qt Bluetooth C++ Classes}{C++ Classes} \endlist @@ -159,9 +153,6 @@ The \l QtBluetooth module exports the following \li qt.bluetooth.osx \li Enables logging of the \l {Qt for macOS} {macOS} implementation \row - \li qt.bluetooth.qml - \li Enables logging of the QtBluetooth QML implementation -\row \li qt.bluetooth.windows \li Enables logging of the \l {Qt for Windows} implementation \endtable diff --git a/src/bluetooth/doc/src/bluetooth-qml.qdoc b/src/bluetooth/doc/src/bluetooth-qml.qdoc deleted file mode 100644 index a6870864..00000000 --- a/src/bluetooth/doc/src/bluetooth-qml.qdoc +++ /dev/null @@ -1,48 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2017 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt local connectivty modules. -** -** $QT_BEGIN_LICENSE:FDL$ -** 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 Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ - - -/*! - -\qmlmodule QtBluetooth \QtVer -\title Qt Bluetooth QML Types -\ingroup qmlmodules -\brief Provides QML types for basic Bluetooth operations on devices. - -The Qt Bluetooth QML Types enable an application to scan for devices and connect -and interact with them in an easier way than the C++ Classes. However, it is a bit -more limited than the C++ API. You can always use the C++ API to create QML -plugins with the flexibility you need. - -To use the classes of the module in your application you need the following -import statement in your \c .qml file: - -\qml \QtVer -import QtBluetooth \1 -\endqml -*/ - |