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/nfc/corkboard | |
| 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/nfc/corkboard')
| -rw-r--r-- | examples/nfc/corkboard/doc/src/corkboard.qdoc | 9 |
1 files changed, 7 insertions, 2 deletions
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} + */ |