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

qdoc has no way to independently document QML enumerations

    XMLWordPrintable

Details

    • Bug
    • Resolution: Unresolved
    • P2: Important
    • None
    • 6.8.3
    • Build tools: qdoc
    • DaVinci 117

    Description

      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.

      Attachments

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

        Activity

          People

            docinfrastructure Documentation Infrastructure Team
            ulherman Ulf Hermann
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:

              Gerrit Reviews

                There are no open Gerrit changes