Details
-
Technical task
-
Resolution: Done
-
P2: Important
-
None
Description
The API documentation for QML types and C++ classes are inconsistent and in many cases, lack the information important to the user.
For any given type or class (for example, Rectangle):
A) Qt version it was introduced in
B) module/library name to import("QtQuick 2.0")
C) Parent type or class
D) Types or class inheriting from it
E) If the class is instantiated as a QML type or the C++ class a type instantiates
F) The QT variable for enabling the module
G) #include directive (C++)
For A, B, E, and F, there needs to be QDoc context commands. QDoc can deduce C, D, and G.
Variables:
A) \since (same as current \since command)
B) \inqmlmodule and \qmlmodule (same as current implementation)
E) \instantiates (same as current \instantiates command)
F) \qtvariable <variable>, where variable is from http://doc-snapshot.qt-project.org/qt5-stable/qmake/qmake-variable-reference.html#qt
Suggested wording:
A) "Introduced in: Qt <version>"
B) "Module: <module name>"
E) "Instantiated by: <QML type>", "Instantiates: <C++ Class>"
F) "Add to .pro file: \c
"
Attachments
For Gerrit Dashboard: QTBUG-32172 | ||||||
---|---|---|---|---|---|---|
# | Subject | Branch | Project | Status | CR | V |
61638,7 | Doc: Unified the summary for C++ classes and QML types. | dev | qt/qtbase | Status: MERGED | -1 | 0 |
62012,5 | Doc: Added \qtvariable command to QDoc. | dev | qt/qtbase | Status: MERGED | +2 | 0 |
62013,5 | Doc: Setting module pages' \qtvariable. | dev | qt/qtbase | Status: MERGED | +2 | 0 |
64717,1 | Doc: Get QDoc to list the QT variable for namespaces. | dev | qt/qtbase | Status: MERGED | +2 | 0 |
66330,3 | Doc: Changed the \since argument to the Qt version. | stable | qt/qtquickcontrols | Status: MERGED | +2 | 0 |
66341,1 | Doc: Made \since command in Dialog QML types consistent. | stable | qt/qtdeclarative | Status: MERGED | +2 | 0 |
66342,2 | Doc: Restore QDoc's use of the \since | stable | qt/qtbase | Status: MERGED | +2 | 0 |
66355,1 | Doc: Made Qt Quick items' \since consistent. | stable | qt/qtdeclarative | Status: MERGED | +2 | 0 |
66364,2 | Doc: Made \since commands in src/qml consistent. | stable | qt/qtdeclarative | Status: MERGED | +2 | 0 |
66374,1 | Doc: Fixed and updated Qt Quick's \qmlmodule page | stable | qt/qtdeclarative | Status: MERGED | +2 | 0 |
66375,3 | Doc: Updated imports, \qmlmodule, and \inqmlmodule versions in src/qml. | stable | qt/qtdeclarative | Status: MERGED | +2 | 0 |
66379,1 | Doc: Removed version from "\inqmlmodule QtPositioning" | stable | qt/qtlocation | Status: MERGED | +2 | 0 |
66380,1 | Doc: Removed version from "\inqmlmodule QtLocation" | stable | qt/qtlocation | Status: MERGED | +2 | 0 |
66381,1 | Doc: Making the \since information consistent with other Qt modules. | stable | qt/qtlocation | Status: ABANDONED | -1 | 0 |
66386,1 | Doc: Removed version from \inqmlmodule. | stable | qt/qtconnectivity | Status: MERGED | +2 | 0 |
66511,1 | Doc: Removed QML version from \inqmlmodule and put it in \qmlmodule | stable | qt/qtsensors | Status: MERGED | +2 | 0 |
67034,1 | Doc: Updated usage of \qmlmodule and \inqmlmodule. | stable | qt/qtmultimedia | Status: MERGED | +2 | 0 |
67035,1 | Doc: Removing version number from the QDoc comments. | stable | qt/qtmultimedia | Status: MERGED | +2 | 0 |
67054,1 | Doc: Adding version of QtWinExtras QML module to \qmlmodule. | stable | qt/qtwinextras | Status: MERGED | +2 | 0 |
67059,1 | Doc: Moved \inqmlmodule version to \qmlmodule for QtQuick.Layouts | stable | qt/qtquickcontrols | Status: MERGED | +2 | 0 |