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

first parameter type missing for \qmlmethod

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: P2: Important P2: Important
    • 5.15.1, 6.1.0 RC
    • 5.14.2, 5.15.0, 6.0.0
    • Build tools: qdoc
    • None
    • All
    • be0ba30d995ac7504d3ec69145ea425d1e68e7df (qt/qttools/dev) 73385a4d45d0b95e3806f78346755d1b008227b4 (qt/qttools/5.15)

      Apparently QDoc will drop the type of the first method parameter present in a \qmlmethod:

      For example, the "Qt.rect" method is documented in src\qml\qml\v8\qqmlbuiltinfunctions.cpp  as follows:

       
      /*!
          \qmlmethod rect Qt::rect(int x, int y, int width, int height)

          Returns a rect with the top-left corner at \a x, \a y and the specified \a width and \a height.
      */
       
      In the online documentation however, the method is documented as follows, and is missing the type for the first parameter:
      "rect rect(x, int y, int width, int height)"

      When looking at the online docs, this seems to be the case for all \qmlmethod's:

      https://doc-snapshots.qt.io/qt6-dev/qml-qtqml-qt.html #rect-method

      https://doc.qt.io/qt-5/qml-qtqml-qt.html#rect-method

      This affects both the current and dev version.

       

        For Gerrit Dashboard: QTBUG-84364
        # Subject Branch Project Status CR V

            treinio Topi Reiniö
            shartte Sebastian Hartte
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved:

                There are no open Gerrit changes