diff options
| author | Jerome Pasion <jerome.pasion@digia.com> | 2014-04-11 16:16:37 +0200 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2014-04-14 12:54:45 +0200 |
| commit | d6f4ada86a20b1e25e61dae3d764fc4a35c3b3d9 (patch) | |
| tree | cfd274e37b011dec9486f63f969628afb705d41e /examples/bluetooth/btchat/doc/src/btchat.qdoc | |
| parent | 2e0f7adbe4257cc3914db0b4a9e6f42cb12f948d (diff) | |
Doc: Improved example documentation
-include a section about running the example (from qtbase/doc/global)
-added links to Qt Bluetooth or Qt NFC
-updated copyright year
-added markup to a string and other small corrections
-added \brief
Task-number: QTBUG-33597
Change-Id: Ia65821549a0e2e3fbf164188982114b4741be233
Reviewed-by: Alex Blasche <alexander.blasche@digia.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Diffstat (limited to 'examples/bluetooth/btchat/doc/src/btchat.qdoc')
| -rw-r--r-- | examples/bluetooth/btchat/doc/src/btchat.qdoc | 7 |
1 files changed, 5 insertions, 2 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: |