Details
-
Bug
-
Resolution: Unresolved
-
P2: Important
-
None
-
6.8.3
-
DaVinci 117, DaVinci 118, DaVinci 119
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:
- The "enumeration" pseudo type for \qmlproperty - this thing does not exist in actual QML.
- Listing the enumeration values as part of the documentation of each property that can hold the enumeration - this leads to duplication.
- Documenting the enumeration as a property. This is wrong because an enumeration is not a property.
Attachments
Gerrit Reviews
For Gerrit Dashboard: QTBUG-134806 | ||||||
---|---|---|---|---|---|---|
# | Subject | Branch | Project | Status | CR | V |
643982,3 | qdoc: C++ code parser: Extract recurring logic for searching nodes | dev | qt/qttools | Status: NEW | +2 | 0 |
643983,3 | qdoc: Introduce QmlEnumNode | dev | qt/qttools | Status: NEW | +2 | 0 |
643984,3 | qdoc: Extend QmlPropertyArguments | dev | qt/qttools | Status: NEW | +2 | 0 |
643985,3 | qdoc: Add sections for QML enumeration documentation | dev | qt/qttools | Status: NEW | +2 | 0 |
644214,3 | qdoc: Introduce \qmlenum command | dev | qt/qttools | Status: NEW | +2 | 0 |
644215,3 | qdoc: Add QmlEnumNode instances to index | dev | qt/qttools | Status: NEW | +2 | 0 |
644216,4 | qdoc: Introduce NativeEnum container | dev | qt/qttools | Status: NEW | 0 | 0 |
644927,1 | qdoc: Process Nodes of type QmlEnum in HelpProjectWriter | dev | qt/qttools | Status: NEW | +2 | 0 |
644928,1 | qdoc: Test \qmlenum output | dev | qt/qttools | Status: NEW | +2 | 0 |