Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-94000

QtNFC: update documentation

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Done
    • Icon: P3: Somewhat important P3: Somewhat important
    • 6.2.0 Alpha
    • None
    • Connectivity: NFC
    • None
    • 5
    • Qt6_Foundation_Sprint 35

      • The module is missing a proper migration guide, like https://doc-snapshots.qt.io/qt6-dev/qtpositioning-changes-qt6.html. Some information can be found in the ApiChangesQt6.txt document in qtconnectivity/src/nfc.
      • Also the main module page should be refactored (see https://doc-snapshots.qt.io/qt6-dev/qtpositioning-index.html as a reference).
      • Newly-introduced features are currently marked "since 6.0". This is not correct, since QtNFC is not released yet. We should use 6.2 or any other suitable version.
      • Add documentation for QNdefNfcIconRecord. This is a public class, that is used in QNdefNfcSmartPosterRecord, but it has no documentation.
      • Fix some qdoc warnings:
        • nfc-android.qdoc:28: (qdoc) warning: Can't link to 'QNearFieldManager::registerNdefMessageHandler()'
        • nfc-android.qdoc:28: (qdoc) warning: Can't link to 'corkboard'

       

        For Gerrit Dashboard: QTBUG-94000
        # Subject Branch Project Status CR V
        350937,2 QNearFieldTarget: fix module name in the documentation dev qt/qtconnectivity Status: MERGED +2 0
        350941,3 QNdefFilter: extend docs dev qt/qtconnectivity Status: MERGED +2 0
        351538,4 QtNFC: extend Android-specific documentation dev qt/qtconnectivity Status: MERGED +2 0
        351651,2 QNearFieldTarger::readNdefMessage - explain corner cases dev qt/qtconnectivity Status: MERGED +2 0
        351933,3 QNdefNfcIconRecord: add documentation dev qt/qtconnectivity Status: MERGED +2 0
        351946,7 QtNFC: add migration guide dev qt/qtconnectivity Status: MERGED +2 0
        352415,2 QtNFC: refactor main module page dev qt/qtconnectivity Status: MERGED +2 0
        352423,4 QtNFC: fix since version for the new methods dev qt/qtconnectivity Status: MERGED +2 0
        353342,3 QtNFC: fix doc issues dev qt/qtconnectivity Status: MERGED +2 0
        353369,2 QtNFC: fix since version for the new methods 6.2 qt/qtconnectivity Status: MERGED +2 0
        353714,2 QtNFC: fix doc issues 6.2 qt/qtconnectivity Status: MERGED +2 0
        354087,2 QtNFC: add migration guide 6.2 qt/qtconnectivity Status: MERGED +2 0

            ivan.solovev Ivan Solovev
            ivan.solovev Ivan Solovev
            Vladimir Minenko Vladimir Minenko
            Alex Blasche Alex Blasche
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved:

                There are no open Gerrit changes