Details
-
Suggestion
-
Resolution: Fixed
-
P2: Important
-
None
-
None
-
cd03ff5e7 (dev), 1f7eff051 (dev), 5001aead1 (dev), 30d4714df (dev), 4371e70ac (dev), c9de6d835 (6.7), e6958a1ab (tqtc/lts-6.5), f7f3ad3bf (tqtc/lts-6.2)
-
DaVinci 97
Description
The \instantiates command causes some confusion for users, both authors and readers. A lively discussion on a change to the QDoc manual's description of the command made it clear that we can do better.
The new command is proposed to be language agnostic yet descriptive in the relationship it describes; \nativetype
Every QML type has exactly one native type. A native type can have multiple QML types.
This single command should establish this one-to-many relationship.
The output should be of the form "X in Y", as in "Foo in QML / QFoo in C++". This is because the types really are the same on the C++ and QML side, apart from their names.
When the new command is ready, the old \instantiates command shall be deprecated.
Documentation must be updated accordingly.
Attachments
Issue Links
- relates to
-
QTBUG-124318 qdoc: Handle multiple QML types instantiating the same C++ type
-
- Closed
-
- resulted in
-
QTBUG-128216 Doc: Replace use of \instantiates with \nativetype
-
- Closed
-