Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-94581 Review and Document new Qt 6.2 CMake API
  3. QTBUG-95712

Document qtbase Qt 6.2 CMake API

    XMLWordPrintable

Details

    • Technical task
    • Resolution: Done
    • P2: Important
    • 6.2.0
    • Build System: CMake
    • None
    • 979e91db2ec68269c7233498a306b9e0e406f6db (qt/qtdoc/dev) 60e373b9c32eb871115d61438d134bbbecf239fc (qt/qtdoc/6.2) 60bbfa0d0ed050dfb06bff7b40e4fac1a4f7a83b (qt/qtdoc/6.2.0)

    Description

      The following CMake functions provided by qtbase are missing documentation:

      • qt_add_library Done
      • qt_add_plugin Done
      • qt_set_finalizer_mode (will be TP in 6.2)
      • qt_disable_unicode_defines Done
      • qt_allow_non_utf8_sources Done
      • qt_extract_metatypes

      The following need adjustments

      • qt_import_plugins mentions Qt5 and is missing doc about NO_DEFAULT option Done
      • qt_finalize_target says it's still in TP Done

      https://doc-snapshots.qt.io/qt6-dev/cmake-command-reference.html

      Furthemore https://doc-snapshots.qt.io/qt6-dev/cmake-get-started.html should be updated to mention the qt_ prefixed functions.

      Attachments

        For Gerrit Dashboard: QTBUG-95712
        # Subject Branch Project Status CR V
        369669,2 Move CMake-related doc files into their own subdirectory dev qt/qtbase Status: MERGED +2 0
        369670,2 Split up cmake-macros.qdoc into one file per command dev qt/qtbase Status: MERGED +2 0
        369671,3 Move some CMake commands out of tech preview status dev qt/qtbase Status: MERGED +2 0
        369672,3 Remove unused qt5_... CMake command snippets dev qt/qtbase Status: MERGED +2 0
        369673,3 Update Qt5:: namespaced targets in snippets to versionless Qt:: dev qt/qtbase Status: MERGED +2 0
        369674,3 Add documentation for the NO_DEFAULT option for qt_import_plugins() dev qt/qtbase Status: MERGED +2 0
        369675,3 Remove inline docs for qt_import_plugins() to avoid duplication dev qt/qtbase Status: MERGED +2 0
        370034,3 Move CMake-related doc files into their own subdirectory 6.2 qt/qtbase Status: MERGED +2 0
        370035,2 Move CMake-related doc files into their own subdirectory 6.2.0 qt/qtbase Status: MERGED +2 0
        370036,3 Remove unused qt5_... CMake command snippets 6.2 qt/qtbase Status: MERGED +2 0
        370037,3 Remove unused qt5_... CMake command snippets 6.2.0 qt/qtbase Status: MERGED +2 0
        370038,2 Update Qt5:: namespaced targets in snippets to versionless Qt:: 6.2.0 qt/qtbase Status: MERGED +2 0
        370039,3 Update Qt5:: namespaced targets in snippets to versionless Qt:: 6.2 qt/qtbase Status: MERGED +2 0
        370040,3 Remove inline docs for qt_import_plugins() to avoid duplication 6.2.0 qt/qtbase Status: MERGED +2 0
        370041,4 Remove inline docs for qt_import_plugins() to avoid duplication 6.2 qt/qtbase Status: MERGED +2 0
        370042,3 Add documentation for the NO_DEFAULT option for qt_import_plugins() 6.2.0 qt/qtbase Status: MERGED +2 0
        370043,2 Split up cmake-macros.qdoc into one file per command 6.2.0 qt/qtbase Status: MERGED +2 0
        370044,3 Split up cmake-macros.qdoc into one file per command 6.2 qt/qtbase Status: MERGED +2 0
        370045,3 Add documentation for the NO_DEFAULT option for qt_import_plugins() 6.2 qt/qtbase Status: MERGED +2 0
        370046,3 Move some CMake commands out of tech preview status 6.2 qt/qtbase Status: MERGED +2 0
        370067,3 Move some CMake commands out of tech preview status 6.2.0 qt/qtbase Status: MERGED +2 0
        371462,2 Document qt_add_library() and update related docs dev qt/qtbase Status: MERGED +2 0
        371690,2 Update the docs now that qt_disable_unicode_defines() is documented dev qt/qtdoc Status: MERGED +2 0
        371691,3 Add docs for qt_disable_unicode_defines() dev qt/qtbase Status: MERGED +2 0
        371702,2 Add docs for qt_allow_non_utf8_sources() dev qt/qtbase Status: MERGED +2 0
        371999,2 Add docs for qt_disable_unicode_defines() 6.2 qt/qtbase Status: MERGED +2 0
        372000,2 Add docs for qt_disable_unicode_defines() 6.2.0 qt/qtbase Status: MERGED +2 0
        372001,2 Add docs for qt_allow_non_utf8_sources() 6.2 qt/qtbase Status: MERGED +2 0
        372002,2 Add docs for qt_allow_non_utf8_sources() 6.2.0 qt/qtbase Status: MERGED +2 0
        372084,3 Add docs for qt_add_plugin() dev qt/qtbase Status: MERGED +2 0
        372367,2 Update the docs now that qt_disable_unicode_defines() is documented 6.2 qt/qtdoc Status: MERGED +2 0
        372368,2 Update the docs now that qt_disable_unicode_defines() is documented 6.2.0 qt/qtdoc Status: MERGED +2 0
        372431,3 Add docs for qt_set_finalizer_mode() dev qt/qtbase Status: MERGED +2 0
        372607,2 Add docs for qt_add_plugin() 6.2 qt/qtbase Status: MERGED +2 0
        372608,2 Add docs for qt_add_plugin() 6.2.0 qt/qtbase Status: MERGED +2 0
        372609,2 Document qt_add_library() and update related docs 6.2.0 qt/qtbase Status: MERGED +2 0
        372610,2 Document qt_add_library() and update related docs 6.2 qt/qtbase Status: MERGED +2 0
        372774,3 Add docs for qt_extract_metatypes() dev qt/qtbase Status: MERGED +2 0
        372782,2 Mention qt_add_executable() in the CMake getting started manual dev qt/qtdoc Status: MERGED +2 0
        372905,2 Mention qt_add_executable() in the CMake getting started manual 6.2 qt/qtdoc Status: MERGED +2 0
        372906,2 Mention qt_add_executable() in the CMake getting started manual 6.2.0 qt/qtdoc Status: MERGED +2 0
        373006,2 Add docs for qt_set_finalizer_mode() 6.2 qt/qtbase Status: MERGED +2 0
        373047,2 Add docs for qt_set_finalizer_mode() 6.2.0 qt/qtbase Status: MERGED +2 0
        373050,2 Add docs for qt_extract_metatypes() 6.2 qt/qtbase Status: MERGED +2 0
        373051,2 Add docs for qt_extract_metatypes() 6.2.0 qt/qtbase Status: MERGED +2 0

        Activity

          People

            crscott Craig Scott
            alexandru.croitor Alexandru Croitor
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes