summaryrefslogtreecommitdiffstats
path: root/src/bluetooth/doc
diff options
context:
space:
mode:
authorAlex Blasche <alexander.blasche@digia.com>2013-06-21 10:51:48 +0200
committerAlex <alexander.blasche@digia.com>2013-06-21 18:41:05 +0200
commit3a68fd3957bd02f417d83bbc113e1a9db82f7684 (patch)
tree22def076338dd230647f2933ee661285a860befa /src/bluetooth/doc
parent09d188e570812a370a54c4ad9821221b26948e3f (diff)
Fix QtBluetooth documentation
Task-number: QTBUG-31913 Change-Id: Ia466c40801994f402b7d6a739d5d43df145c432d Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Alex <alexander.blasche@digia.com>
Diffstat (limited to 'src/bluetooth/doc')
-rw-r--r--src/bluetooth/doc/qtbluetooth.qdocconf11
-rw-r--r--src/bluetooth/doc/src/bluetooth-cpp.qdoc4
-rw-r--r--src/bluetooth/doc/src/bluetooth-overview.qdoc4
-rw-r--r--src/bluetooth/doc/src/bluetooth-qml.qdoc2
4 files changed, 11 insertions, 10 deletions
diff --git a/src/bluetooth/doc/qtbluetooth.qdocconf b/src/bluetooth/doc/qtbluetooth.qdocconf
index 99bf575b..3f748c36 100644
--- a/src/bluetooth/doc/qtbluetooth.qdocconf
+++ b/src/bluetooth/doc/qtbluetooth.qdocconf
@@ -2,21 +2,22 @@ include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
project = QtBluetooth
description = Qt Bluetooth Reference Documentation
-version = 5.0.0
+url = http://qt-project.org/doc/qt-$QT_VER/qtbluetooth
+version = $QT_VERSION
examplesinstallpath = bluetooth
qhp.projects = QtBluetooth
qhp.QtBluetooth.file = qtbluetooth.qhp
-qhp.QtBluetooth.namespace = org.qt-project.qtbluetooth.500
+qhp.QtBluetooth.namespace = org.qt-project.qtbluetooth.$QT_VERSION_TAG
qhp.QtBluetooth.virtualFolder = qtbluetooth
qhp.QtBluetooth.indexTitle = Qt Bluetooth
qhp.QtBluetooth.indexRoot =
-qhp.QtBluetooth.filterAttributes = qtbluetooth 5.0.0 qtrefdoc
-qhp.QtBluetooth.customFilters.Qt.name = QtBluetooth 5.0.0
-qhp.QtBluetooth.customFilters.Qt.filterAttributes = qtbluetooth 5.0.0
+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.classes.title = C++ Classes
qhp.QtBluetooth.subprojects.classes.indexTitle = Qt Bluetooth C++ Classes
diff --git a/src/bluetooth/doc/src/bluetooth-cpp.qdoc b/src/bluetooth/doc/src/bluetooth-cpp.qdoc
index 26bbc3e9..ae15b869 100644
--- a/src/bluetooth/doc/src/bluetooth-cpp.qdoc
+++ b/src/bluetooth/doc/src/bluetooth-cpp.qdoc
@@ -34,8 +34,8 @@ and connecting them.
The \l{Qt Bluetooth} C++ API enables an application to scan for devices and
- connect and interact with them in a more flexible way than the \l{Qt
- Bluetooth QML API}.
+ connect and interact with them in a more flexible way than the \l {Qt
+ Bluetooth QML Types}.
To use the C++ library in your application, add the following configuration
option to your \c .pro file:
diff --git a/src/bluetooth/doc/src/bluetooth-overview.qdoc b/src/bluetooth/doc/src/bluetooth-overview.qdoc
index d62321f7..941219f8 100644
--- a/src/bluetooth/doc/src/bluetooth-overview.qdoc
+++ b/src/bluetooth/doc/src/bluetooth-overview.qdoc
@@ -87,12 +87,12 @@
To be able to create SPP connections, you need to register a Server one one device by using
QRfcommServer.
- \snippet chatserver.cpp Create the server
+ \snippet btchat/chatserver.cpp Create the server
Connect to this server from another device playing the client role by using a
QBluetoothSocket.
- \snippet chatclient.cpp startClient
+ \snippet btchat/chatclient.cpp startClient
Using such a connection allows to exchange any form of data in both directions.
It is perfectly suited for use cases like gaming or syncing the state between two instances of
diff --git a/src/bluetooth/doc/src/bluetooth-qml.qdoc b/src/bluetooth/doc/src/bluetooth-qml.qdoc
index 19e4fa4e..dd3141d3 100644
--- a/src/bluetooth/doc/src/bluetooth-qml.qdoc
+++ b/src/bluetooth/doc/src/bluetooth-qml.qdoc
@@ -33,7 +33,7 @@
\ingroup qmlmodules
\brief Provides QML types for basic Bluetooth operations on devices
-The Qt Bluetooth QML API enables an application to scan for devices and connect and
+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.