Loading...

XML

Word

Printable

Details

Type: User Story
Resolution: Fixed
Priority: P2: Important
Fix Version/s: 6.8.3, 6.9.0 Beta3, 6.10.0 FF
Affects Version/s: None
Component/s: Build tools: qdoc
Labels:
- davinci

Sprint:
DaVinci 109, DaVinci 110, DaVinci 111, DaVinci 112
Commits:
f863e7000 (dev), 98bd958a0 (6.9), 8144e43d1 (6.8)

Description

A lot of our QML API is documented by the C++ types, while it should use QML types. See e.g. https://doc.qt.io/qt-6/qml-qtquick-application.html :

QString should be string
QList<QString> should be list<string>
QFont should be font

Anyhow, this error is easy to make, as the surrounding C++ code actually does use the native C++ types - the conversion to the QML native types when the class is used from QML is implicit.

Can qdoc at least warn about such cases?

Attachments

Issue Links

relates to

QTBUG-130092 Documentation: WindowContainer doesn't link to Window

Closed

QTBUG-131261 Use QML types Application QML Type documentation

Closed

QTBUG-119727 Automatically generate QML documentation from C++

Reported

Gerrit Reviews

- Issue Only
- Show All Reviews
- Show Open Reviews
- Show All Issues
- Show Open Issues

For Gerrit Dashboard: QTBUG-131243
#	Subject	Branch	Project	Status	CR	V
609780,6	qdoc: Warn about C++ types in QML property documentation	dev	qt/qttools	Status: MERGED	+2	0
621116,2	qdoc: Warn about C++ types in QML property documentation	6.9	qt/qttools	Status: MERGED	+2	0
621256,2	qdoc: Warn about C++ types in QML property documentation	6.8	qt/qttools	Status: MERGED	+2	0