diff options
author | Topi Reinio <topi.reinio@qt.io> | 2023-09-12 12:07:47 +0000 |
---|---|---|
committer | Topi Reinio <topi.reinio@qt.io> | 2023-09-15 10:04:17 +0000 |
commit | 83ba6a889f676361a25defe4739b8fd2f9bdcae7 (patch) | |
tree | 2b24a6ef1d3974606c82524660df8e5c910c6c76 /examples/quick | |
parent | b50fee10b97b2d40263bd2c6c45c87d3bc2a2084 (diff) |
Doc: Fix undocumented parameters and broken links
* src/qml/jsapi/qjsengine.cpp:
(qdoc) warning: Can't link to 'qvariant_cast()'
* src/quick/items/qquickrhiitem.cpp:
(qdoc) warning: Undocumented parameter 'item' in
QQuickRhiItemRenderer::synchronize()
(qdoc) warning: Can't link to 'msaaColorBuffer()'
(qdoc) warning: Can't link to 'resolveTexture()'
* src/quick/scenegraph/util/qsgtextnode.cpp:
(qdoc) warning: No such enum item 'Text.NativeRendering' in
QSGTextNode::RenderType
(qdoc) warning: Undocumented parameter 'color' in
QSGTextNode::setColor()
(qdoc) warning: Undocumented parameter 'color' in
QSGTextNode::setSelectionColor()
(qdoc) warning: Undocumented parameter 'viewport' in
QSGTextNode::setViewport()
* examples/quick/rendercontrol/rendercontrol_rhi/doc/src/
rendercontrol_rhi.qdoc:
(qdoc) warning: Can't link to 'QWidget-based'
(qdoc) warning: Can't link to 'QAnimationDriver'
Mark all documentation modules in qtdeclarative as free of warnings.
Change-Id: I97cc059701c351b53cdeeb5fc2feff923c5a76a8
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'examples/quick')
-rw-r--r-- | examples/quick/rendercontrol/rendercontrol_rhi/doc/src/rendercontrol_rhi.qdoc | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/examples/quick/rendercontrol/rendercontrol_rhi/doc/src/rendercontrol_rhi.qdoc b/examples/quick/rendercontrol/rendercontrol_rhi/doc/src/rendercontrol_rhi.qdoc index 7e1436bc06..3fbd9939d4 100644 --- a/examples/quick/rendercontrol/rendercontrol_rhi/doc/src/rendercontrol_rhi.qdoc +++ b/examples/quick/rendercontrol/rendercontrol_rhi/doc/src/rendercontrol_rhi.qdoc @@ -78,7 +78,7 @@ scenegraph when rendering. The main render loop is the following. This also shows how to perform - GPU->CPU readbacks of images. Once a QImage is available, the \l + GPU->CPU readbacks of images. Once a QImage is available, the QWidget-based user interface updates accordingly. We will omit diving into the details for that here. @@ -108,7 +108,7 @@ expected to perceive. Consider rendering 5 frames in a row, in a tight loop. How the animations in those 5 frames move depends on the speed with which the CPU executes the loop iterations. That is almost never ideal. To ensure - consistent animations, install a custom \l QAnimationDriver. While this is + consistent animations, install a custom QAnimationDriver. While this is an undocumented (but public) API meant for advanced users, the example here provides a simple example of using it. |