summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Zanetti <michael.zanetti@nokia.com>2012-03-22 16:20:16 +0100
committerQt by Nokia <qt-info@nokia.com>2012-03-26 17:38:14 +0200
commit1f80a5ac15e145dc2743bc5e4261ed8474a41a82 (patch)
tree4c4bea028251b43dafeedc789f5d1e1943b07b9d
parent5cf45810b6e7da0dca43be0989afa74a830846e6 (diff)
downloadqtconnectivity-1f80a5ac15e145dc2743bc5e4261ed8474a41a82.tar.gz
use correct namings as defined in the guidelines
"Qt Bluetooth C++ API" or "C++ API" "Qt Bluetooth QML API" or "QML API" Change-Id: I729562581efe35d0fa4bb722e8469e62d1ec6c31 Reviewed-by: Aleksi Uotila <aleksi.uotila@nokia.com> Reviewed-by: Alex <alex.blasche@nokia.com>
-rw-r--r--doc/src/bluetooth-cpp.qdoc8
-rw-r--r--doc/src/bluetooth-overview.qdoc16
-rw-r--r--doc/src/bluetooth-qml.qdoc9
3 files changed, 17 insertions, 16 deletions
diff --git a/doc/src/bluetooth-cpp.qdoc b/doc/src/bluetooth-cpp.qdoc
index 9cfc7566..2456bc62 100644
--- a/doc/src/bluetooth-cpp.qdoc
+++ b/doc/src/bluetooth-cpp.qdoc
@@ -31,15 +31,15 @@
\page bluetooth-cpp.html
\module QtBluetooth
-\title Bluetooth C++ API
+\title Qt Bluetooth C++ API
\brief An API enabling basic Bluetooth operations like scanning for Devices
and connecting them.
\ingroup qtconnectivity
\ingroup qtconnectivity-c++
-The Bluetooth C++ API enables an application to scan for devices and connect and
-interact with them in a more flexible way than the \l{Bluetooth QML API}.
+The 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}.
\tableofcontents
@@ -50,7 +50,7 @@ include directive for the appropriate class. For example:
\snippet ../doc/src/snippets/doc_src_qtbluetooth.cpp include
-The Bluetooth API is a Qt Add-On API and for thus wrapped in a namespace. To
+The Qt Bluetooth C++ API is a Qt Add-On API and for thus wrapped in a namespace. To
make use of the namespace use:
\snippet ../doc/src/snippets/doc_src_qtbluetooth.cpp namespace
diff --git a/doc/src/bluetooth-overview.qdoc b/doc/src/bluetooth-overview.qdoc
index f5e79fe3..05cf6d42 100644
--- a/doc/src/bluetooth-overview.qdoc
+++ b/doc/src/bluetooth-overview.qdoc
@@ -29,7 +29,7 @@
\ingroup technology-apis
\title Qt Bluetooth Module
\page qtbluetooth-overview.html
-\brief The Bluetooth API enables connectivity with other Bluetooth enabled devices.
+\brief The Qt Bluetooth API enables connectivity with other Bluetooth enabled devices.
\tableofcontents
@@ -59,7 +59,7 @@ the Bluetooth connection.
you can do, getting started, some simple examples and tutorials.
\section1 Getting Started
- As shown in the above list, the Bluetooth API has three main purposes. The first one is to
+ As shown in the above list, the Qt Bluetooth API has three main purposes. The first one is to
obtain local and remote device information. The first steps in retrieving device information is
to check if Bluetooth is available on the device and read the local device address and name. The
QBluetoothLocalDevice is the one to provide all of this information. Additionally you can use it
@@ -107,24 +107,24 @@ the Bluetooth connection.
example.
To get started with adding the Qt Bluetooth API to your project, see the
- \l{Qt Bluetooth Examples}{Examples} or check out the \l{Bluetooth QML API}{QML} and
- \l{Bluetooth C++ API}{C++} API's with their "Getting started" sections.
+ \l{Qt Bluetooth Examples}{Examples} or check out the \l{Qt Bluetooth QML API}{QML} and
+ \l{Qt Bluetooth C++ API}{C++} API's with their "Getting started" sections.
\section2 QML API
There are a number of QML Types available in the Qt Bluetooth API.
\list
- \li \l {Bluetooth QML API}{Bluetooth QML API}
+ \li \l {Qt Bluetooth QML API}{Qt Bluetooth QML API}
\endlist
- \section2 C++ Bluetooth API
+ \section2 C++ API
- The C++ Bluetooth API requires gives a bit more flexibility on how
+ The Qt Bluetooth C++ API requires gives a bit more flexibility on how
to interact with remote devices.
\list
- \li \l {Bluetooth C++ API} {Bluetooth C++ API}.
+ \li \l {Qt Bluetooth C++ API} {Qt Bluetooth C++ API}.
\endlist
*/
diff --git a/doc/src/bluetooth-qml.qdoc b/doc/src/bluetooth-qml.qdoc
index 57e4cf68..40bead3c 100644
--- a/doc/src/bluetooth-qml.qdoc
+++ b/doc/src/bluetooth-qml.qdoc
@@ -30,14 +30,14 @@
\page bluetooth-qml.html
-\title Bluetooth QML API
+\title Qt Bluetooth QML API
\brief A QML API enabling basic Bluetooth operations like scanning for Devices
and connecting them.
\ingroup qtconnectivity
\ingroup qtconnectivity-qml
-The Bluetooth API enables an application to scan for devices and connect and
+The Qt Bluetooth QML API enables 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.
@@ -50,7 +50,8 @@ To import the Bluetooth types, use the following:
\snippet ../doc/src/snippets/doc_src_qtbluetooth.qml import
-After importing the Bluetooth API you can use its types. This example shows how to connect to a remote RFCOMM (SPP) server using BluetoothSocket:
+After importing the Qt Bluetooth QML API you can use its types. This example shows how
+to connect to a remote RFCOMM (SPP) server using BluetoothSocket:
\snippet ../doc/src/snippets/doc_src_qtbluetooth.qml service
@@ -69,7 +70,7 @@ After importing the Bluetooth API you can use its types. This example shows how
\row
\li \l{bttennis}{QML Bluetooth Tennis}
- \li The tennis game using a QML interface to the Bluetooth API. It must connect to an
+ \li The tennis game using a QML interface to the Qt Bluetooth QML API. It must connect to an
instance of the C++ \l{bttennis}{Bluetooth Tennis} game to play.
\row
\li \l{btscanner}{QML Bluetooth Scanner}