summaryrefslogtreecommitdiffstats
path: root/examples
diff options
context:
space:
mode:
authorJani Heikkinen <jani.heikkinen@digia.com>2014-04-23 12:44:00 +0300
committerJani Heikkinen <jani.heikkinen@digia.com>2014-04-23 12:44:00 +0300
commitf665f9d8c5e1bf491b479c94b140a03de6b459fc (patch)
tree78c5a21ffb63ad0b234a7685ff05f2e9cb93a3ce /examples
parent764780a8d30d375d21f033c7216e4c54b193a428 (diff)
parent9b11226f3d23dfb4c6b8457f2a839584666cda6a (diff)
Merge remote-tracking branch 'origin/release' into stable
Diffstat (limited to 'examples')
-rw-r--r--examples/bluetooth/btchat/doc/src/btchat.qdoc7
-rw-r--r--examples/bluetooth/btfiletransfer/doc/src/btfiletransfer.qdoc7
-rw-r--r--examples/bluetooth/btscanner/doc/src/btscanner.qdoc9
-rw-r--r--examples/bluetooth/picturetransfer/doc/src/picturetransfer.qdoc40
-rw-r--r--examples/bluetooth/pingpong/doc/src/pingpong.qdoc6
-rw-r--r--examples/bluetooth/scanner/doc/src/scanner.qdoc5
-rw-r--r--examples/nfc/annotatedurl/doc/src/annotatedurl.qdoc14
-rw-r--r--examples/nfc/corkboard/doc/src/corkboard.qdoc9
-rw-r--r--examples/nfc/ndefeditor/doc/src/ndefeditor.qdoc12
-rw-r--r--examples/nfc/poster/doc/src/poster.qdoc13
10 files changed, 86 insertions, 36 deletions
diff --git a/examples/bluetooth/btchat/doc/src/btchat.qdoc b/examples/bluetooth/btchat/doc/src/btchat.qdoc
index 77f73fd1..a78b9ede 100644
--- a/examples/bluetooth/btchat/doc/src/btchat.qdoc
+++ b/examples/bluetooth/btchat/doc/src/btchat.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt local connectivty modules.
@@ -28,8 +28,9 @@
/*!
\example btchat
\title Bluetooth Chat Example
+ \brief An example showing communication through Bluetooth.
- The Bluetooth Chat example shows how to use the Qt Connectivity Bluetooth API to communicate
+ The Bluetooth Chat example shows how to use the \l{Qt Bluetooth} API to communicate
with another application on a remote device using Bluetooth.
\image btchat-example.png
@@ -38,6 +39,8 @@
application always acts as both a server and a client eliminating the need to determine who
should connect to whom.
+ \include examples-run.qdocinc
+
\section1 Chat Server
The chat server is implemented by the ChatServer class. The ChatServer class is declared as:
diff --git a/examples/bluetooth/btfiletransfer/doc/src/btfiletransfer.qdoc b/examples/bluetooth/btfiletransfer/doc/src/btfiletransfer.qdoc
index aeeffffb..53832725 100644
--- a/examples/bluetooth/btfiletransfer/doc/src/btfiletransfer.qdoc
+++ b/examples/bluetooth/btfiletransfer/doc/src/btfiletransfer.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt local connectivty modules.
@@ -28,6 +28,7 @@
/*!
\example btfiletransfer
\title Bluetooth File Transfer Example
+ \brief An example showing the use of Bluetooth Object Push Profile (OPP).
The Bluetooth File Transfer example is an application to transfer files
via a bluetooth connection. This example does not work on Android due to
@@ -35,4 +36,8 @@
\image btfiletransfer-example.png
+ \include examples-run.qdocinc
+
+ \sa {Qt Bluetooth}
+
*/
diff --git a/examples/bluetooth/btscanner/doc/src/btscanner.qdoc b/examples/bluetooth/btscanner/doc/src/btscanner.qdoc
index e67b761a..e4d28ee2 100644
--- a/examples/bluetooth/btscanner/doc/src/btscanner.qdoc
+++ b/examples/bluetooth/btscanner/doc/src/btscanner.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt local connectivty modules.
@@ -28,9 +28,14 @@
/*!
\example btscanner
\title Bluetooth Scanner Example
+ \brief An example showing how to locate Bluetooth devices.
- An example of how to locate Bluetooth devices.
+ An example showing how to locate Bluetooth devices.
\image btscanner-example.png
+ \include examples-run.qdocinc
+
+ \sa {Qt Bluetooth}
+
*/
diff --git a/examples/bluetooth/picturetransfer/doc/src/picturetransfer.qdoc b/examples/bluetooth/picturetransfer/doc/src/picturetransfer.qdoc
index 7a166121..3b0218d4 100644
--- a/examples/bluetooth/picturetransfer/doc/src/picturetransfer.qdoc
+++ b/examples/bluetooth/picturetransfer/doc/src/picturetransfer.qdoc
@@ -28,18 +28,20 @@ a/****************************************************************************
/*!
\example picturetransfer
\title QML Bluetooth Picture Push Example
+\brief An example showing the use Bluetooth Object Push Profile (OPP).
-The Bluetooth Picture Push example shows how to use the \l QBluetoothTransferManager
-API. The example transfers a local image to a remote device. Unfortunately this example cannot be used on
-Android as Qt does not support the Object Push Profile on this platform.
+The Bluetooth Picture Push example shows how to use the \l
+QBluetoothTransferManager API. The example transfers a local image to a remote
+device. Unfortunately this example cannot be used on Android as Qt does not
+support the Object Push Profile (OPP) on this platform.
-On the first user interface page the application scans for remote Bluetooth devices. The user must select
-the appropriate device to continue:
+On the first user interface page the application scans for remote Bluetooth
+devices. The user must select the appropriate device to continue:
\image opp-example-1.png
-The next page presents a list of image files on the device. The files must be located under
-\l QStandardPaths::PicturesLocation}:
+The next page presents a list of image files on the device. The files must be
+located under \l QStandardPaths::PicturesLocation}:
\image opp-example-2.png
@@ -47,29 +49,35 @@ Once the picture was selected the UI shows the progress of the file transfer:
\image opp-example-3.png
+\include examples-run.qdocinc
+
+\sa {Qt Bluetooth}
+
\section1 Device Discovery
-The device discovery uses the \l BluetoothDiscoveryModel to detect the remote devices. Each discovery is displayed
-as an entry in a list. Once a device was selected the device address is stored in the \c root element. More
-details about the \c root element will follow further below.
+The device discovery uses the \l BluetoothDiscoveryModel to detect the remote
+devices. Each discovery is displayed as an entry in a list. Once a device was
+selected the device address is stored in the \c root element. More details about
+the \c root element will follow further below.
\snippet picturetransfer/DeviceDiscovery.qml Discovery-1
\snippet picturetransfer/DeviceDiscovery.qml Discovery-2
\section1 File Selection
-The file is selected with the help of \l FolderListModel. Once again the selected file is stored in the \c root
-element:
+The file is selected with the help of \l FolderListModel. Once again the
+selected file is stored in the \c root element:
\snippet picturetransfer/PictureSelector.qml FileSelect-1
\snippet picturetransfer/PictureSelector.qml FileSelect-2
\snippet picturetransfer/PictureSelector.qml FileSelect-3
\snippet picturetransfer/PictureSelector.qml FileSelect-4
-\section1 The root element
+\section1 Root Element
-The already mentioned \c root element collects the necessary pieces of data for the picture transfer.
-Once the file name has been set it triggers the file transfer:
+The already mentioned \c root element collects the necessary pieces of data for
+the picture transfer. Once the file name has been set it triggers the file
+transfer:
\snippet picturetransfer/bttransfer.qml Root-1
@@ -77,7 +85,7 @@ Once the file name has been set it triggers the file transfer:
\snippet picturetransfer/bttransfer.qml Root-3
\snippet picturetransfer/bttransfer.qml Root-3
-\section1 The File Transfer
+\section1 File Transfer
The file transfer is implemented in C++:
diff --git a/examples/bluetooth/pingpong/doc/src/pingpong.qdoc b/examples/bluetooth/pingpong/doc/src/pingpong.qdoc
index df7fcc34..0e82a71a 100644
--- a/examples/bluetooth/pingpong/doc/src/pingpong.qdoc
+++ b/examples/bluetooth/pingpong/doc/src/pingpong.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt Toolkit.
@@ -28,6 +28,7 @@
/*!
\example pingpong
\title Bluetooth QML Ping Pong example
+ \brief A QML example showing Bluetooth communication.
The Bluetooth QML Ping Pong example presents the socket communication between two
Bluetooth devices. The basic concept is the ping pong game where two players
@@ -35,6 +36,8 @@
\image intro.png
+ \include examples-run.qdocinc
+
At the beginning, the user selects the role. One device acts as a server and the second
one as a client. After selecting the role, adjustments to the screen size are done
(two devices might have different screen sizes). The server side starts a service named
@@ -77,4 +80,3 @@
\image intro1.png
*/
-
diff --git a/examples/bluetooth/scanner/doc/src/scanner.qdoc b/examples/bluetooth/scanner/doc/src/scanner.qdoc
index 62b9680c..f4e292a8 100644
--- a/examples/bluetooth/scanner/doc/src/scanner.qdoc
+++ b/examples/bluetooth/scanner/doc/src/scanner.qdoc
@@ -1,5 +1,6 @@
/****************************************************************************
**
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Copyright (C) 2013 Aaron McCarthy <mccarthy.aaron@gmail.com>
** Contact: http://www.qt-project.org/legal
**
@@ -28,6 +29,7 @@
/*!
\example scanner
\title QML Bluetooth Scanner Example
+\brief A QML example about locating Bluetooth devices.
This is an example on how to locate Bluetooth devices in QML.
@@ -50,4 +52,7 @@ from local cache information and may not always be complete and accurate. The pr
perform a minimal discovery are time constraints. A full service discovery can take up to two minutes.
Note that not every platform supports a minimal discovery. In such cases the API performs a full discovery.
+\include examples-run.qdocinc
+
+\sa {Qt Bluetooth}
*/
diff --git a/examples/nfc/annotatedurl/doc/src/annotatedurl.qdoc b/examples/nfc/annotatedurl/doc/src/annotatedurl.qdoc
index 2a84c8b3..08001fdf 100644
--- a/examples/nfc/annotatedurl/doc/src/annotatedurl.qdoc
+++ b/examples/nfc/annotatedurl/doc/src/annotatedurl.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt local connectivty modules.
@@ -28,10 +28,16 @@
/*!
\example annotatedurl
\title Annotated URL Example
+\brief An example showing reading from formatted NFC Data Exchange Format (NDEF) messages.
-The Annotated URL example displays the contents of specifically formatted NDEF messages read from
-an NFC Tag. The NDEF message should contain a URI record, an optional image/* MIME record, and one
-or more localized Text records.
+The Annotated URL example displays the contents of specifically formatted NFC
+Data Exchange Format (NDEF) messages read from an NFC Tag. The NDEF message
+should contain a URI record, an optional \c image/* MIME record, and one or more
+localized Text records.
\image annotatedurl.png
+
+\include examples-run.qdocinc
+
+\sa {Qt NFC}
*/
diff --git a/examples/nfc/corkboard/doc/src/corkboard.qdoc b/examples/nfc/corkboard/doc/src/corkboard.qdoc
index 4027fc26..db982d2e 100644
--- a/examples/nfc/corkboard/doc/src/corkboard.qdoc
+++ b/examples/nfc/corkboard/doc/src/corkboard.qdoc
@@ -28,12 +28,17 @@
/*!
\example corkboard
\title QML CorkBoard Example
+\brief A QML example about displaying NFC Data Exchange Format (NDEF) messages.
The QML CorkBoard example displays the contents of NDEF messages read from an
NFC Tag. Each newly detected NDEF message is added to the corkboard and can be
-dragged into an arbitrary position on the board. The corkboard has a "Personal"
-and "Work" space. The workspace can be changed by sliding left or right.
+dragged into an arbitrary position on the board. The corkboard has a \e Personal
+and \e Work space. The workspace can be changed by sliding left or right.
\image corkboard.png
+\include examples-run.qdocinc
+
+\sa {Qt NFC}
+
*/
diff --git a/examples/nfc/ndefeditor/doc/src/ndefeditor.qdoc b/examples/nfc/ndefeditor/doc/src/ndefeditor.qdoc
index 346feb8e..3ebc5525 100644
--- a/examples/nfc/ndefeditor/doc/src/ndefeditor.qdoc
+++ b/examples/nfc/ndefeditor/doc/src/ndefeditor.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt local connectivty modules.
@@ -28,9 +28,15 @@
/*!
\example ndefeditor
\title NDEF Editor Example
+\brief An example about reading and writing NFC Data Exchange Format (NDEF) messages to NFC Forum Tags.
-The NDEF Editor example reads and writes NDEF messages to NFC Forum Tags. NDEF messages can be
-composed by adding records of supported types.
+The NDEF Editor example reads and writes NFC Data Exchange Format (NDEF)
+messages to NFC Forum Tags. NDEF messages can be composed by adding records of
+supported types.
\image ndefeditor.png
+
+\include examples-run.qdocinc
+
+\sa {Qt NFC}
*/
diff --git a/examples/nfc/poster/doc/src/poster.qdoc b/examples/nfc/poster/doc/src/poster.qdoc
index 125afd95..05cfd6d3 100644
--- a/examples/nfc/poster/doc/src/poster.qdoc
+++ b/examples/nfc/poster/doc/src/poster.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt local connectivty modules.
@@ -28,11 +28,16 @@
/*!
\example poster
\title QML Poster Example
+\brief A QML example about reading and displaying NFC Data Exchange Format (NDEF) messages.
-The QML Poster example displays the contents of specifically formatted NDEF messages read from an
-NFC Tag. The NDEF message should contain a URI record, an optional image/* MIME record, and one
-or more localized Text records.
+The QML Poster example displays the contents of specifically formatted NFC Data
+Exchange Format (NDEF) messages read from an NFC Tag. The NDEF message should
+contain a URI record, an optional \c image/* MIME record, and one or more
+localized Text records.
\image qml-poster-example.png
+\include examples-run.qdocinc
+
+\sa {Qt NFC}
*/