Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-32173 Qt 5.2 Documentation Issues (meta bug)
  3. QTBUG-33555

Doc: Import statement takes version info only from /inqmlmodule

    XMLWordPrintable

Details

    • d6b7276178ffac755cd80c935eac96b09654839c, 54098579981c72c2a568a9c1a9eb1d21919a42f0, ca7433d0421ecf4de229c4395a34bdfabc5830a7

    Description

      This means that when changing from for example 1.0 to 1.1 you need to update the doc of every types in that class. (That's a lot of them in qtdeclarative or qtquickcontrols)

      It would be convenient to have the module version specified in only one place.

      Ffor info the pro file of the qml imports contains a IMPORT_VERSION tag if that could help. Otherwise maybe using the version given in \qmlmodule could be used.

      For the moment we have for a module:

          \qmlmodule QtQuick.Controls 1.1
          \title Qt Quick Controls QML Types
          \ingroup qmlmodules
          \brief Provides QML types for user interfaces.
      

      And an item in that module:

          \qmltype Button
          \inqmlmodule QtQuick.Controls 1.0
          \since QtQuick.Controls 1.0
          \ingroup controls
          \brief A push button with a text label.
      

      If you want Button to have the import statement "import QtQuick.Controls 1.1" in the doc, you need to change " \inqmlmodule QtQuick.Controls 1.1"

      When using:

      • \inqmlmodule QtQuick.Controls
      • \inqmlmodule QtQuick.Controls 1
      • \inqmlmodule QtQuick.Controls 2
        The version set in \qmlmodule is ignored and version is 1.0 or 2.0 for the last case.
        Default major and minor versions are 1 and 0 in qtbase/src/tools/qdoc/node.cpp

      Attachments

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

        Activity

          People

            gbk Martin Smith (Qt)
            carochao Caroline Chao (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes