summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKai Köhne <kai.koehne@qt.io>2024-01-04 16:10:38 +0100
committerKai Köhne <kai.koehne@qt.io>2024-01-11 13:58:20 +0100
commitaca4a5649b5459f2f507de73bee351d171744d3f (patch)
tree79096cdbf827c162154eb0e28624907b59285c35
parent020b1cb66ff43757acbbbff0bdcb91c123d12e65 (diff)
Doc: Tweak description of Qt NFC examples
Pick-to: 6.6 6.7 Change-Id: I784aea736d77df873289141535dcbe20f7c0d131 Reviewed-by: Ivan Solovev <ivan.solovev@qt.io>
-rw-r--r--examples/nfc/annotatedurl/doc/src/annotatedurl.qdoc9
-rw-r--r--examples/nfc/ndefeditor/doc/src/ndefeditor.qdoc7
-rw-r--r--examples/nfc/ndefeditor/icons/ndefeditor/qt_attribution.json2
3 files changed, 10 insertions, 8 deletions
diff --git a/examples/nfc/annotatedurl/doc/src/annotatedurl.qdoc b/examples/nfc/annotatedurl/doc/src/annotatedurl.qdoc
index 1041c70f..b76c349f 100644
--- a/examples/nfc/annotatedurl/doc/src/annotatedurl.qdoc
+++ b/examples/nfc/annotatedurl/doc/src/annotatedurl.qdoc
@@ -5,9 +5,10 @@
\example annotatedurl
\title Annotated URL
\examplecategory {Connectivity}
-\brief The example shows reading from formatted NFC Data Exchange Format (NDEF) messages.
+\meta tags {nfc, ndef, widgets}
+\brief Reads formatted NFC Data Exchange Format (NDEF) messages.
-The Annotated URL example displays the contents of specifically
+The Annotated URL example uses \l{Qt NFC} to display 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.
@@ -15,8 +16,8 @@ image/* MIME record, and one or more localized Text records.
This is the initial state of the example:
\image annotatedurl.png
-In this example the NFC Tag used contains a text record and an URI record.
-The UI gets updated accordingly to:
+If a tag is touched, its NDEF content will be shown. Here is the UI
+for a tag that contains a text record and URI record:
\image annotatedurl2.png
diff --git a/examples/nfc/ndefeditor/doc/src/ndefeditor.qdoc b/examples/nfc/ndefeditor/doc/src/ndefeditor.qdoc
index 3ce6bc1e..0c7a0841 100644
--- a/examples/nfc/ndefeditor/doc/src/ndefeditor.qdoc
+++ b/examples/nfc/ndefeditor/doc/src/ndefeditor.qdoc
@@ -3,11 +3,12 @@
/*!
\example ndefeditor
-\title NDEF Editor Example
+\title NDEF Editor
\examplecategory {Connectivity}
-\brief An example of reading and writing NFC Data Exchange Format (NDEF) messages to NFC Forum Tags.
+\meta tags {nfc, ndef}
+\brief Reads and writes NFC Data Exchange Format (NDEF) messages to NFC Forum Tags.
-The NDEF Editor example reads and writes NFC Data Exchange Format
+The NDEF Editor example uses \l{Qt NFC} to read and write NFC Data Exchange Format
(NDEF) messages to NFC Forum Tags. NDEF messages can be composed by
adding text and URI records. Records can be deleted by swiping them to the left.
diff --git a/examples/nfc/ndefeditor/icons/ndefeditor/qt_attribution.json b/examples/nfc/ndefeditor/icons/ndefeditor/qt_attribution.json
index 9b1ae419..b9ee69b4 100644
--- a/examples/nfc/ndefeditor/icons/ndefeditor/qt_attribution.json
+++ b/examples/nfc/ndefeditor/icons/ndefeditor/qt_attribution.json
@@ -2,7 +2,7 @@
"Id": "ndefeditor",
"Name": "Selected Material Icons",
"QDocModule": "qtnfc",
- "QtUsage": "Used in NDEF Editor Example for QtNfc.",
+ "QtUsage": "Used in NDEF Editor example for Qt NFC.",
"QtParts": [
"examples"
],