From 5f249c3d0105b5b5d104770925b7b2fcefd183f6 Mon Sep 17 00:00:00 2001
From: Ivan Solovev <ivan.solovev@qt.io>
Date: Tue, 17 May 2022 13:17:23 +0200
Subject: QtNfc: create "Supported Features" doc page

To provide information which access methods and tag types are supported
for different platforms

Fixes: QTBUG-94792
Change-Id: I85cf94f3108cbb341d98b0ef93c0e11f0f7316ee
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Ievgenii Meshcheriakov <ievgenii.meshcheriakov@qt.io>
---
 src/nfc/doc/src/nfc-features.qdoc | 88 +++++++++++++++++++++++++++++++++++++++
 src/nfc/doc/src/nfc-index.qdoc    |  1 +
 2 files changed, 89 insertions(+)
 create mode 100644 src/nfc/doc/src/nfc-features.qdoc

(limited to 'src')

diff --git a/src/nfc/doc/src/nfc-features.qdoc b/src/nfc/doc/src/nfc-features.qdoc
new file mode 100644
index 00000000..f47aaadc
--- /dev/null
+++ b/src/nfc/doc/src/nfc-features.qdoc
@@ -0,0 +1,88 @@
+/****************************************************************************
+**
+** Copyright (C) 2022 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\page qtnfc-features.html
+\title Supported NFC Features
+\ingroup connectivity-nfc
+\inmodule QtNfc
+\brief Summary of supported NFC features on different platforms.
+
+Qt NFC provides two options for reading and writing the data. These options are
+reflected in the \l {QNearFieldTarget::}{AccessMethod} enum.
+
+\list
+  \li \l {QNearFieldTarget::}{NdefAccess} - using NDEF messages via
+      \l {QNearFieldTarget::}{readNdefMessages()} and
+      \l {QNearFieldTarget::}{writeNdefMessages()}.
+  \li \l {QNearFieldTarget::}{TagTypeSpecificAccess} - sending custom commands
+      using \l {QNearFieldTarget::}{sendCommand()} and getting the results via
+      \l {QNearFieldTarget::}{requestResponse()}.
+\endlist
+
+\l {QNearFieldTarget::}{TagTypeSpecificAccess} implies that the
+user might need to send different data based on the NFC Tag Type. Tag types
+recognized by Qt NFC are defined in the \l {QNearFieldTarget::}{Type} enum.
+
+Qt NFC support for different access methods and tag types varies depending on
+the platform. The table below shows currently supported subsets of features
+for every platform.
+
+\table
+  \header
+    \li Platform
+    \li Recognized Tag Types
+    \li NDEF Support
+    \li Tag Specific Access
+  \row
+    \li \l {Qt NFC on Android}{Android}
+    \li All from the \l {QNearFieldTarget::}{Type} enum
+    \li Yes
+    \li Yes
+  \row
+    \li iOS
+    \li \list
+          \li \l {QNearFieldTarget::}{NfcTagType4}
+          \li \l {QNearFieldTarget::}{NfcTagType4A}
+          \li \l {QNearFieldTarget::}{NfcTagType4B}
+          \li \l {QNearFieldTarget::}{ProprietaryTag}
+        \endlist
+    \li No
+    \li Yes - for supported tag types
+  \row
+    \li Linux, Windows, macOS
+
+        (implemented using \l {PC/SC in Qt NFC}{PC/SC})
+    \li \list
+          \li \l {QNearFieldTarget::}{NfcTagType4}
+          \li \l {QNearFieldTarget::}{ProprietaryTag}
+        \endlist
+    \li Yes  - for \l {QNearFieldTarget::}{NfcTagType4}
+    \li Yes - for \l {QNearFieldTarget::}{ProprietaryTag}
+\endtable
+
+*/
diff --git a/src/nfc/doc/src/nfc-index.qdoc b/src/nfc/doc/src/nfc-index.qdoc
index 8b9a91fe..f6a06ad4 100644
--- a/src/nfc/doc/src/nfc-index.qdoc
+++ b/src/nfc/doc/src/nfc-index.qdoc
@@ -62,6 +62,7 @@ and write NDEF messages on NFC Forum Tags, and send tag-specific commands.
 
 \list
     \li \l {Qt NFC Overview}
+    \li \l {Supported NFC Features}
     \li \l {Qt NFC on Android}
     \li \l {PC/SC in Qt NFC}
 \endlist
-- 
cgit v1.2.1