Details
-
Bug
-
Resolution: Fixed
-
P2: Important
-
6.8.0
-
None
-
5a6a9b1d5 (dev), 133af018d (6.8), 6b0c495b5 (dev), b166290d8 (6.8), 647bee671 (dev), 4e85a4f40 (dev), d3dad28a5 (dev), 334460407 (dev), adaf1fb10 (dev), c76b845d9 (6.9), 5d2f40a14 (6.9), eb44663ea (6.9), 604dcc714 (6.9), b70e61788 (6.9), 5661c07fe (6.8)
Description
In class documentation, QIODevice::Read, QIODevice::Write ... is often not linked anymore:
This is due to Qt 6, where the flags being actually defined not in QIODevice, but QIODeviceBase. Therefore qdoc doesn't acknowledge the links anymore in 'heuristic mode' (so without an explicit \l.
Affected documentation (most likely incomplete):
- https://doc.qt.io/qt-6/qsavefile.html#open
- https://doc.qt.io/qt-6/qfile.html#open
- https://doc.qt.io/qt-6/qbuffer.html#open
- https://doc.qt.io/qt-6/qprocess.html#setStandardOutputFile
- https://doc.qt.io/qt-6/qsettings.html#registerFormat
- https://doc.qt.io/qt-6/qtemporaryfile.html#open
- https://doc.qt.io/qt-6/qt.html#endl
Proposed fixes:
Fix type name to QIODeviceBase:: and use explicit link command (\l).
Attachments
For Gerrit Dashboard: QTBUG-131484 | ||||||
---|---|---|---|---|---|---|
# | Subject | Branch | Project | Status | CR | V |
606177,4 | Doc: Improve QSaveFile::open description | dev | qt/qtbase | Status: MERGED | +2 | 0 |
606761,2 | Doc: Improve QSaveFile::open description | 6.8 | qt/qtbase | Status: MERGED | +2 | 0 |
609426,4 | Doc: Improve QFile::open description | dev | qt/qtbase | Status: MERGED | +2 | 0 |
609626,4 | Doc: Improve QBuffer::open description | dev | qt/qtbase | Status: MERGED | +2 | 0 |
609628,5 | Doc: Improve QProcess setStandardOutputFile description | dev | qt/qtbase | Status: MERGED | +2 | 0 |
609642,5 | Doc: Improve QTemporaryFile::open() descriptions | dev | qt/qtbase | Status: MERGED | +2 | 0 |
609643,7 | Doc: Fix links to QIODeviceBase:: flags | dev | qt/qtbase | Status: MERGED | +2 | 0 |
609775,2 | Doc: Fix links to QIODeviceBase:: flags | dev | qt/qtpositioning | Status: MERGED | +2 | 0 |
609817,2 | Doc: Fix links to QIODeviceBase:: flags | 6.8 | qt/qtpositioning | Status: MERGED | +2 | 0 |
611420,2 | Doc: Improve QFile::open description | 6.9 | qt/qtbase | Status: MERGED | +2 | 0 |
611421,2 | Doc: Improve QBuffer::open description | 6.9 | qt/qtbase | Status: MERGED | +2 | 0 |
611422,2 | Doc: Improve QProcess setStandardOutputFile description | 6.9 | qt/qtbase | Status: MERGED | +2 | 0 |
611423,2 | Doc: Improve QTemporaryFile::open() descriptions | 6.9 | qt/qtbase | Status: MERGED | +2 | 0 |
611424,2 | Doc: Fix links to QIODeviceBase:: flags | 6.9 | qt/qtbase | Status: MERGED | +2 | 0 |
611625,2 | Doc: Improve QFile::open description | 6.8 | qt/qtbase | Status: MERGED | +2 | 0 |
611627,2 | Doc: Improve QBuffer::open description | 6.8 | qt/qtbase | Status: MERGED | +2 | 0 |
611629,2 | Doc: Improve QProcess setStandardOutputFile description | 6.8 | qt/qtbase | Status: MERGED | +2 | 0 |
611630,2 | Doc: Improve QTemporaryFile::open() descriptions | 6.8 | qt/qtbase | Status: MERGED | +2 | 0 |
611631,2 | Doc: Fix links to QIODeviceBase:: flags | 6.8 | qt/qtbase | Status: MERGED | +2 | 0 |