summaryrefslogtreecommitdiffstats
path: root/examples/nfc
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2014-04-11 16:16:37 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-04-14 12:54:45 +0200
commitd6f4ada86a20b1e25e61dae3d764fc4a35c3b3d9 (patch)
treecfd274e37b011dec9486f63f969628afb705d41e /examples/nfc
parent2e0f7adbe4257cc3914db0b4a9e6f42cb12f948d (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')
-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
4 files changed, 35 insertions, 13 deletions
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}
*/