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