[Development] New documentation errors since Qt 5.3.1

Sze Howe Koh szehowe.koh at gmail.com
Wed Sep 10 14:47:06 CEST 2014 

Hi all,

Using qdoc from Qt 5.4.0 Alpha1, I generated documentation from the
"v5.4.0-alpha1" and "v5.3.1" git tags. Then, I diff'ed the qdoc outputs
using QDocErrorTracker [1].

Below is a list of errors that are new in Qt 5.4.0 Alpha1. Could those with
knowledge of the relevant areas please fix them if time permits?


===== qtbase.git =====
src/corelib/global/qnamespace.qdoc:1252
    warning: Undocumented enum item 'Key_Find' in Qt::Key
src/corelib/global/qnamespace.qdoc:1252
    warning: Undocumented enum item 'Key_Open' in Qt::Key
src/corelib/global/qnamespace.qdoc:1252
    warning: Undocumented enum item 'Key_MicVolumeUp' in Qt::Key
src/corelib/global/qnamespace.qdoc:1252
    warning: Undocumented enum item 'Key_Redo' in Qt::Key
src/corelib/global/qnamespace.qdoc:1252
    warning: Undocumented enum item 'Key_Undo' in Qt::Key
src/corelib/global/qnamespace.qdoc:1252
    warning: Undocumented enum item 'Key_New' in Qt::Key
src/corelib/global/qnamespace.qdoc:1252
    warning: Undocumented enum item 'Key_MicVolumeDown' in Qt::Key
src/corelib/global/qglobal.cpp:1106
    warning: No such enum item 'MV_IOS_8_0' in QSysInfo::MacVersion
src/corelib/kernel/qmath.qdoc:206
    warning: No such parameter 'radians' in qNextPowerOfTwo()
src/corelib/kernel/qmath.qdoc:206
    warning: No such parameter 'value' in qRadiansToDegrees()


===== qtmacextras.git =====
src/macextras/qmactoolbar.mm:66
    warning: Can't link to 'QWindow::attachToWindow'
examples/macextras/embeddedqwindow/doc/src/qtmacextras-example-embeddedqwindow.qdoc:28
    warning: Can't link to 'Qt for OS X'
src/macextras/doc/src/qtmacextras-examples.qdoc:41
    warning: Can't link to 'Qt for OS X'
examples/macextras/macfunctions/doc/src/qtmacextras-example-macfunctions.qdoc:28
    warning: Can't link to 'Qt for OS X'
examples/macextras/macpasteboardmime/doc/src/qtmacextras-example-macpasteboardmime.qdoc:28
    warning: Can't link to 'Qt for OS X'


===== qtdeclarative.git =====
src/qml/doc/src/qmlfunctions.qdoc:159
    warning: Cannot find 'QQmlEgine' in '\relates'
src/qml/doc/src/qmlfunctions.qdoc:181
    warning: Cannot find 'QQmlEgine' in '\relates'
src/imports/statemachine/finalstate.cpp:73
    warning: Cannot find file to quote from:
'qml/statemachine/finalstate.qml'
src/imports/statemachine/finalstate.cpp:73
    warning: Unable to parse QML snippet: "Expected token `numeric
literal'" at line 1, column 1
src/imports/statemachine/finalstate.cpp:73
    warning: Unexpected '\snippet (//! [document])'
src/imports/statemachine/signaltransition.cpp:227
    warning: Cannot find file to quote from:
'qml/statemachine/signaltransition.qml'
src/imports/statemachine/signaltransition.cpp:227
    warning: Unable to parse QML snippet: "Expected token `numeric
literal'" at line 1, column 1
src/imports/statemachine/signaltransition.cpp:227
    warning: Unexpected '\snippet (//! [document])'
src/imports/statemachine/signaltransition.cpp:239
    warning: Cannot find file to quote from:
'qml/statemachine/signaltransitionsignal.qml'
src/imports/statemachine/signaltransition.cpp:239
    warning: Unable to parse QML snippet: "Expected token `numeric
literal'" at line 1, column 1
src/imports/statemachine/signaltransition.cpp:239
    warning: Unexpected '\snippet (//! [document])'
src/imports/statemachine/signaltransition.cpp:253
    warning: Cannot find file to quote from:
'qml/statemachine/guardcondition.qml'
src/imports/statemachine/signaltransition.cpp:253
    warning: Unable to parse QML snippet: "Expected token `numeric
literal'" at line 1, column 1
src/imports/statemachine/signaltransition.cpp:253
    warning: Unexpected '\snippet (//! [document])'
src/imports/statemachine/statebase.cpp:136
    warning: Cannot find file to quote from:
'qml/statemachine/basicstate.qml'
src/imports/statemachine/statebase.cpp:136
    warning: Unable to parse QML snippet: "Expected token `numeric
literal'" at line 1, column 1
src/imports/statemachine/statebase.cpp:136
    warning: Unexpected '\snippet (//! [document])'
src/imports/statemachine/statebase.cpp:199
    warning: Cannot find file to quote from:
'qml/statemachine/historystate.qml'
src/imports/statemachine/statebase.cpp:199
    warning: Unable to parse QML snippet: "Expected token `numeric
literal'" at line 1, column 1
src/imports/statemachine/statebase.cpp:199
    warning: Unexpected '\snippet (//! [document])'
src/imports/statemachine/statemachine.cpp:117
    warning: Cannot find file to quote from:
'qml/statemachine/simplestatemachine.qml'
src/imports/statemachine/statemachine.cpp:117
    warning: Unable to parse QML snippet: "Expected token `numeric
literal'" at line 1, column 1
src/imports/statemachine/statemachine.cpp:117
    warning: Unexpected '\snippet (//! [document])'
src/imports/statemachine/timeouttransition.cpp:96
    warning: Cannot find file to quote from:
'qml/statemachine/timeouttransition.qml'
src/imports/statemachine/timeouttransition.cpp:96
    warning: Unable to parse QML snippet: "Expected token `numeric
literal'" at line 1, column 1
src/imports/statemachine/timeouttransition.cpp:96
    warning: Unexpected '\snippet (//! [document])'
src/quick/items/qquickwindow.cpp:3848
    warning: Cannot find 'QQuickWindow::RenderJobSchedule' specified with
'\enum' in any header file
src/quick/util/qquickfontmetrics.cpp:320
    warning: Invalid syntax in '\qmlmethod'
src/quick/util/qquicktextmetrics.cpp:198
    warning: QML property documented multiple times: 'real
QtQuick::TextMetrics::width'
src/quick/util/qquicktextmetrics.cpp:245
    warning: Invalid syntax in '\qmlmethod'
src/quick/items/qquickframebufferobject.cpp:283
    warning: No documentation for
'QQuickFramebufferObject::isTextureProvider()'
src/quick/items/qquickframebufferobject.cpp:301
    warning: No documentation for
'QQuickFramebufferObject::releaseResources()'
src/quick/items/qquickframebufferobject.cpp:288
    warning: No documentation for
'QQuickFramebufferObject::textureProvider()'
src/quick/items/qquickpainteditem.cpp:570
    warning: No documentation for 'QQuickPaintedItem::isTextureProvider()'
src/quick/items/qquickpainteditem.cpp:552
    warning: No documentation for 'QQuickPaintedItem::releaseResources()'
src/quick/items/qquickpainteditem.cpp:575
    warning: No documentation for 'QQuickPaintedItem::textureProvider()'
src/quick/items/qquickrendercontrol.cpp:144
    warning: No documentation for
'QQuickRenderControl::QQuickRenderControl()'
src/quick/items/qquickwindow.h:75
    warning: No documentation for 'QQuickWindow::RenderStage'
src/quick/items/qquickwindow.cpp:3908
    warning: No documentation for 'QQuickWindow::qmlAttachedProperties()'
examples/quick/demos/maroon/doc/src/maroon.qdoc:28
    warning: Can't link to 'SoundEffect'
examples/quick/demos/maroon/doc/src/maroon.qdoc:28
    warning: Can't link to 'Qt Quick Particles'
src/quick/util/qquicktextmetrics.cpp:120
    warning: Can't link to 'elidedText'
src/quick/util/qquicktextmetrics.cpp:149
    warning: Can't link to 'elidedText'
src/quick/util/qquickfontmetrics.cpp:268
    warning: Can't link to 'height()'
src/quick/util/qquickfontmetrics.cpp:337
    warning: No documentation for 'FontMetrics::elidedText'
src/quick/util/qquicktextmetrics.cpp:40
    error: HTML file already exists; overwriting
qtbase/doc/qtquick/qml-qtquick-textmetrics.html
src/quick/util/qquicktextmetrics.cpp:40
    error: HTML file already exists; overwriting
qtbase/doc/qtquick/qml-qtquick-textmetrics-members.html


===== qtconnectivity.git =====
src/bluetooth/qlowenergyservice.cpp:300
    warning: Can't link to 'createServiceObject()'


===== qtquickcontrols.git =====
src/controls/ToolButton.qml:79
    warning: Unable to parse QML snippet: "Expected token `}'" at line 2,
column 5
src/controls/doc/src/qtquickcontrols-examples.qdoc:127
    warning: Unable to parse QML snippet: "Expected token `numeric
literal'" at line 2, column 1
src/controls/doc/src/qtquickcontrols-examples.qdoc:189
    warning: Command '\printuntil' failed at end of file
'calendar/src/sqleventmodel.cpp'
src/dialogs/qquickdialog.cpp:296
    warning: QML property documented multiple times: 'bool Dialog::visible'
src/dialogs/qquickdialog.cpp:388
    warning: Can't link to 'clickedButton'
src/dialogs/qquickdialog.cpp:73
    warning: Can't link to 'accept()'
src/dialogs/qquickdialog.cpp:81
    warning: Can't link to 'reject()'
src/dialogs/qquickplatformfiledialog.cpp:44
    warning: Can't link to 'QCoreApplication::applicationName'
src/dialogs/qquickplatformfiledialog.cpp:44
    warning: Can't link to 'QCoreApplication::organizationName'
src/dialogs/qquickplatformfiledialog.cpp:44
    warning: Can't link to 'QCoreApplication::organizationDomain'


===== qtmultimedia.git =====
src/imports/multimedia/qdeclarativecamera.cpp:923
    warning: No QML property group command found; using \qmlpropertygroup
QtMultimedia::Camera::metaData
src/imports/multimedia/qdeclarativecamera.cpp:1000
    warning: No QML property group command found; using \qmlpropertygroup
QtMultimedia::Camera::viewfinder


===== qtdoc.git =====
doc/src/qmlapp/glossary.qdoc:28
    warning: Can't link to 'qtquick-qmltypereference.html'
doc/src/qmlapp/usecases/layouts.qdoc:27
    warning: Can't link to 'qtquick-qmltypereference.html#positioning'


===== qtlocation.git =====
src/location/doc/src/examples/declarative-places.qdoc:28
    warning: Can't link to 'GeoCircle'
src/location/doc/src/qml-maps.qdoc:35
    warning: Can't link to 'GeoCodeModel'


Thanks,
Sze-Howe

[1] https://github.com/JKSH/QDocErrorTracker
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.qt-project.org/pipermail/development/attachments/20140910/4ea54c34/attachment.html>

More information about the Development mailing list