From d6f4ada86a20b1e25e61dae3d764fc4a35c3b3d9 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Fri, 11 Apr 2014 16:16:37 +0200 Subject: Doc: Improved example documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit -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 Reviewed-by: Topi Reiniö --- examples/nfc/poster/doc/src/poster.qdoc | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) (limited to 'examples/nfc/poster/doc') 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} */ -- cgit v1.2.3