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

qdoc has no way to independently document QML enumerations

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Fixed
    • Icon: P2: Important P2: Important
    • None
    • 6.8.3
    • Build tools: qdoc
    • e6b38aea5 (dev), 967078281 (dev), 149a8d7d4 (dev), 1fd95c958 (dev), c6fa0b976 (dev), 531c721ab (dev), d5652d694 (dev), d364f2a5a (dev)
    • DaVinci 117, DaVinci 118, DaVinci 119, DaVinci 120

      Since QML types can have enumerations there should be a \qmlenum directive to document them, like there is a \qmlproperty directive for properties. Various hacks have been established around this problem. For example:

      1. The "enumeration" pseudo type for \qmlproperty - this thing does not exist in actual QML.
      2. Listing the enumeration values as part of the documentation of each property that can hold the enumeration - this leads to duplication.
      3. Documenting the enumeration as a property. This is wrong because an enumeration is not a property.

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

            treinio Topi Reiniƶ
            ulherman Ulf Hermann
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved:

                There is 1 open Gerrit change