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

Show CMake library target in Qt class documentation

    XMLWordPrintable

    Details

    • Type: User Story
    • Status: Closed
    • Priority: P2: Important
    • Resolution: Fixed
    • Affects Version/s: 5.15
    • Fix Version/s: 6.0.0
    • Component/s: Documentation
    • Story Points:
      8
    • Sprint:
      Da Vinci sprint 9, Da Vinci sprint 10
    • Commits:
      d9d84929927c589ec4e6d4e944a9ae4004be31bd

      Description

      Do add a 'CMake target' to the table at the start of class documentations.

       For [QFile|https://doc.qt.io/qt-5/qfile.html,] this might look like

      Header: #include <QFile>
      qmake: QT += core
      CMake target: Qt::Core
      Inherits: QFileDevice
      Inherited by: QTemporaryFile

      This would allow users to instantly see which target needs to be used in target_link_libraries to make use of the class. The right call to get the target imported should be documented on the module page.

        Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

            Assignee:
            paulwicking Paul Wicking
            Reporter:
            kkohne Kai Köhne
            Votes:
            1 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Gerrit Reviews

                There are no open Gerrit changes