diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2022-03-15 16:53:04 +0100 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2022-03-16 07:59:14 +0100 |
| commit | 8b79b1ce2cb0353c85919600a1ff269e56a537e6 (patch) | |
| tree | 87ae3bb2bf8e63543e740a79080f6f62a5132010 | |
| parent | a9e1dee9964170aae39fa2081e056426efa4989e (diff) | |
Add QtNfc documentation
Amends 65b6c342f0f9c2cf6006f7ebd78dd06e66e1ef1a.
Task-number: PYSIDE-1570
Change-Id: I869a706bab514b87c870e8faa994cc1acf36be2e
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
| -rw-r--r-- | sources/pyside6/doc/extras/QtNfc.rst | 31 | ||||
| -rw-r--r-- | sources/pyside6/doc/modules.rst | 7 | ||||
| -rw-r--r-- | sources/pyside6/doc/qtmodules/pyside-qtnfc.qdocconf.in | 2 |
3 files changed, 40 insertions, 0 deletions
diff --git a/sources/pyside6/doc/extras/QtNfc.rst b/sources/pyside6/doc/extras/QtNfc.rst new file mode 100644 index 000000000..9cd0181f0 --- /dev/null +++ b/sources/pyside6/doc/extras/QtNfc.rst @@ -0,0 +1,31 @@ +Enables connectivity between NFC enabled devices. + +The NFC API provides connectivity between NFC enabled devices. + +Overview +^^^^^^^^ + +NFC is an extremely short-range (less than 20 centimeters) wireless technology +and has a maximum transfer rate of 424 kbit/s. NFC is ideal for transferring +small packets of data when two devices are touched together. + +The NFC API provides APIs for interacting with NFC Forum Tags and NFC Forum +Devices, including target detection and loss, registering NDEF message +handlers, reading and writing NDEF messages on NFC Forum Tags and sending tag +specific commands. + +Using the Module +^^^^^^^^^^^^^^^^ + +To include the definitions of modules classes, use the following +directive: + +:: + + import PySide6.QtNfc + +Guides +^^^^^^ + + * `Qt NFC Overview <https://doc.qt.io/qt-6/qtnfc-overview.html>`_ + * `Qt NFC on Android <https://doc.qt.io/qt-6/nfc-android.html>`_ diff --git a/sources/pyside6/doc/modules.rst b/sources/pyside6/doc/modules.rst index dcf481320..9b20d6906 100644 --- a/sources/pyside6/doc/modules.rst +++ b/sources/pyside6/doc/modules.rst @@ -86,6 +86,13 @@ Qt Modules --- + :mod:`QtNfc <PySide6.QtNfc>` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + The NFC API provides connectivity between NFC enabled devices. + + --- + :mod:`QtNetworkAuth <PySide6.QtNetworkAuth>` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/sources/pyside6/doc/qtmodules/pyside-qtnfc.qdocconf.in b/sources/pyside6/doc/qtmodules/pyside-qtnfc.qdocconf.in new file mode 100644 index 000000000..833bbc019 --- /dev/null +++ b/sources/pyside6/doc/qtmodules/pyside-qtnfc.qdocconf.in @@ -0,0 +1,2 @@ +include(@QT_SRC_DIR@/../qtconnectivity/src/nfc/doc/qtnfc.qdocconf) +include(../pyside-config.qdocconf) |