summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@digia.com>2013-10-01 13:51:33 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-10-14 12:44:21 +0200
commitf674d4a5ade8b24dcb36c3c219c0fd5a842c1bfe (patch)
tree725cab8f631684432a473ebd00bb8727ccba450c /src
parentf4474f93b9e0a7df48e94f3fec34a0de64b482bd (diff)
Doc: language and style review doc qtconnectivity
Reviewed doc Bluetooth and NFC Task-number: QTBUG-32173 Change-Id: I80f81c2123c3ee4fc269f471123f332dc39ee958 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src')
-rw-r--r--src/bluetooth/doc/src/bluetooth-cpp.qdoc4
-rw-r--r--src/bluetooth/doc/src/bluetooth-overview.qdoc8
-rw-r--r--src/bluetooth/doc/src/bluetooth-qml.qdoc6
-rw-r--r--src/bluetooth/doc/src/examples.qdoc13
-rw-r--r--src/nfc/doc/src/examples.qdoc6
-rw-r--r--src/nfc/doc/src/nfc-cpp.qdoc2
-rw-r--r--src/nfc/doc/src/nfc-index.qdoc4
-rw-r--r--src/nfc/doc/src/nfc-overview.qdoc6
-rw-r--r--src/nfc/doc/src/nfc-qml.qdoc4
9 files changed, 28 insertions, 25 deletions
diff --git a/src/bluetooth/doc/src/bluetooth-cpp.qdoc b/src/bluetooth/doc/src/bluetooth-cpp.qdoc
index 7bd28c70..9bef246b 100644
--- a/src/bluetooth/doc/src/bluetooth-cpp.qdoc
+++ b/src/bluetooth/doc/src/bluetooth-cpp.qdoc
@@ -29,10 +29,10 @@
\module QtBluetooth
\title Qt Bluetooth C++ Classes
-\brief An API enabling basic Bluetooth operations like scanning for devices
-and connecting them.
+\brief Enables basic Bluetooth operations like scanning for devices and connecting them.
\ingroup modules
\qtvariable bluetooth
+\since 5.2
The \l{Qt Bluetooth} C++ API enables an application to scan for devices and
diff --git a/src/bluetooth/doc/src/bluetooth-overview.qdoc b/src/bluetooth/doc/src/bluetooth-overview.qdoc
index c101ac34..347ab2cf 100644
--- a/src/bluetooth/doc/src/bluetooth-overview.qdoc
+++ b/src/bluetooth/doc/src/bluetooth-overview.qdoc
@@ -59,7 +59,7 @@
\section1 Scanning for Bluetooth Devices
Similar to the QBluetoothLocalDevice, the API offers QBluetoothDeviceInfo which provides
- that information for remote devices. While you can just create QBluetoothDeviceInfo objects on
+ that information for remote devices. Although you can just create QBluetoothDeviceInfo objects on
your own and fill them with data, the easier way is to use the QBluetoothDeviceDiscoveryAgent to
start an automated search for visible Bluetooth devices within the connectable range.
@@ -69,7 +69,7 @@
Once the desired device is found, there are two main use cases provided by Qt Bluetooth. The
simpler is to send files via the Obex Object Push Profile (OPP). As the name describes, this
- profile can only push files from one device to another but not pull files or browse the remote
+ profile can only push files from one device to another, but not pull files or browse the remote
file system. Because of this limitation, this profile does not require the two devices to be
paired before exchanging data. To push files to remote devices, create a
QBluetoothTransferRequest and ask the QBluetoothTransferManager to push the file contained in
@@ -79,7 +79,7 @@
\section1 Exchanging Data Between Devices
- The more flexible approach to do communication between two Bluetooth enabled devices, is to
+ The more flexible approach for communication between two Bluetooth enabled devices, is to
create a virtual serial port connection and freely exchange data over that connection. This can
be done by the Serial Port Profile (SPP). The Serial Port Profile emulates a serial connection
over the Bluetooth transport protocol RFCOMM.
@@ -95,7 +95,7 @@
\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
+ It is perfectly suited for gaming or for syncing the state between two instances of
an application on two devices. For more detailed descriptions on how to configure the server
and client, please refer to the detailed description sections in the QRfcommServer and
QBluetoothSocket classes. A good example to start with SPP is the \l{btchat}{Bluetooth Chat}
diff --git a/src/bluetooth/doc/src/bluetooth-qml.qdoc b/src/bluetooth/doc/src/bluetooth-qml.qdoc
index f9ff3d30..9c9fe0aa 100644
--- a/src/bluetooth/doc/src/bluetooth-qml.qdoc
+++ b/src/bluetooth/doc/src/bluetooth-qml.qdoc
@@ -31,10 +31,10 @@
\qmlmodule QtBluetooth 5.2
\title Qt Bluetooth QML Types
\ingroup qmlmodules
-\brief Provides QML types for basic Bluetooth operations on devices
+\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
+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.
diff --git a/src/bluetooth/doc/src/examples.qdoc b/src/bluetooth/doc/src/examples.qdoc
index ec98dbc5..8884b3c8 100644
--- a/src/bluetooth/doc/src/examples.qdoc
+++ b/src/bluetooth/doc/src/examples.qdoc
@@ -29,12 +29,15 @@
\ingroup all-examples
\page bluetooth-examples.html
\title Qt Bluetooth Examples
- \brief Examples for the QtBluetooth module
+ \brief Examples for the QtBluetooth module.
- This is a variety of examples that cover the entire range of the the Qt Bluetooth API. You will find them in their own documentation but are also accessible from here.
+ This is a variety of examples that cover the entire range of the the Qt
+ Bluetooth API. You will find them in their own documentation but they are also
+ accessible from here.
\section2 C++ Tutorial
- The \l{btchat}{Bluetooth Chat} example contains a tutorial on how to use the C++ API to create a RFCOMM server and client and exchange data between them.
+ The \l{btchat}{Bluetooth Chat} example contains a tutorial on how to use the
+ C++ API to create a RFCOMM server and client, and exchange data between them.
\section2 C++ Examples
\table 80%
@@ -60,8 +63,8 @@
\li Description
\row
\li \l{bttennis}{QML Bluetooth Tennis}
- \li The tennis game using a QML interface to the Bluetooth API. It must connect to an
- instance of the C++ \l{bttennis}{Bluetooth Tennis} game to play.
+ \li The tennis game using a QML interface to the Bluetooth API. It
+ must connect to an instance of the C++ \l{bttennis}{Bluetooth Tennis} game to play.
\row
\li \l{btscanner}{QML Bluetooth Scanner}
\li A QML implementation of the Bluetooth device scanner.
diff --git a/src/nfc/doc/src/examples.qdoc b/src/nfc/doc/src/examples.qdoc
index f49c0d8f..1f473991 100644
--- a/src/nfc/doc/src/examples.qdoc
+++ b/src/nfc/doc/src/examples.qdoc
@@ -29,10 +29,10 @@
\ingroup all-examples
\page nfc-examples.html
\title Qt NFC Examples
-\brief Examples for the QtNfc module
+\brief Examples for the QtNfc module.
-This is a variety of examples that cover the entire range of the the Qt NFC API. You will find them
-in their own documentation but are also accessible from here.
+This is a variety of examples that cover the entire range of the Qt NFC API. You will find them
+in their own documentation, but they are also accessible from here.
\section2 C++ Tutorial
diff --git a/src/nfc/doc/src/nfc-cpp.qdoc b/src/nfc/doc/src/nfc-cpp.qdoc
index b52db05b..4df93e69 100644
--- a/src/nfc/doc/src/nfc-cpp.qdoc
+++ b/src/nfc/doc/src/nfc-cpp.qdoc
@@ -33,7 +33,7 @@
\title Qt NFC C++ Classes
\brief An API for accessing NFC Forum Tags.
-The \l{Qt NFC} C++ API enables an application to access NFC Forum Tagss.
+The \l{Qt NFC} C++ API enables an application to access NFC Forum Tags.
To use the C++ library in your application, add the following configuration
option to your \c .pro file:
diff --git a/src/nfc/doc/src/nfc-index.qdoc b/src/nfc/doc/src/nfc-index.qdoc
index a353a759..7309e4cc 100644
--- a/src/nfc/doc/src/nfc-index.qdoc
+++ b/src/nfc/doc/src/nfc-index.qdoc
@@ -28,10 +28,10 @@
/*!
\page qtnfc-index.html
\title Qt NFC
-\brief Qt NFC enables connectivity between NFC enabled devices.
+\brief Enables connectivity between NFC enabled devices.
NFC is an extremely short-range (less than 20 centimeters) wireless technology and has a
-maximum transfer rate of 424 kbit/s. NFC is ideal for transferring small packets of data when two
+maximum transfer rate of 424 kbit/s. NFC is ideal for transferring small packets of data when two
devices are touched together.
The NFC API provides APIs for interacting with NFC Forum Tags and NFC Forum Devices, including
diff --git a/src/nfc/doc/src/nfc-overview.qdoc b/src/nfc/doc/src/nfc-overview.qdoc
index 6c479c62..25e193a6 100644
--- a/src/nfc/doc/src/nfc-overview.qdoc
+++ b/src/nfc/doc/src/nfc-overview.qdoc
@@ -29,14 +29,14 @@
\ingroup technology-apis
\title Qt NFC Overview
\page qtnfc-overview.html
-\brief The Qt NFC classes provides access to NFC enabled devices.
+\brief Provides access to NFC enabled devices.
\tableofcontents
With the Qt NFC API typical use cases are:
\list
- \li Detect NFC tags entering and leaving communication range.
+ \li Detect NFC tags entering and leaving the communication range.
\li Read and write NDEF message on NFC Forum Tags.
\li Register an NDEF message handler for a particular content type.
\endlist
@@ -44,6 +44,6 @@ With the Qt NFC API typical use cases are:
The following sections describe how to use QtNfc C++ classes for the above use cases.
\section1 Detect NFC tags entering and leaving communication range.
-\section1 Read and write NDEF message on NFC Forum Tags.
+\section1 Read and write an NDEF message on NFC Forum Tags.
\section1 Register an NDEF message handler for a particular content type.
*/
diff --git a/src/nfc/doc/src/nfc-qml.qdoc b/src/nfc/doc/src/nfc-qml.qdoc
index a8151bba..42e57159 100644
--- a/src/nfc/doc/src/nfc-qml.qdoc
+++ b/src/nfc/doc/src/nfc-qml.qdoc
@@ -31,9 +31,9 @@
\qmlmodule QtNfc 5.2
\title Qt NFC QML Types
\ingroup qmlmodules
-\brief Provides QML types for accessing NFC Forum Tags
+\brief Provides QML types for accessing NFC Forum Tags.
-To use the classes of the module in your application you need the following
+To use the classes of the module in your application, you need the following
import statement in your \c .qml file:
\snippet doc_src_qtnfc.qml import