summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2018-11-07 10:29:11 +0100
committerTopi Reiniƶ <topi.reinio@qt.io>2018-11-07 12:50:21 +0000
commitd682d612ec2ae75f12cde2525a0cacee798b2b49 (patch)
tree6ca6fcfbf32e87830327afe04368eb601f9f8738 /src
parent325db3b1dabb8508e5c1b4f22d61399e3439f3df (diff)
Doc: Fix various documentation warnings
Change-Id: I3eecd06bba9438b5aa472f3ba7ecaecdeda985e2 Reviewed-by: Martin Smith <martin.smith@qt.io>
Diffstat (limited to 'src')
-rw-r--r--src/core/nodes/qcomponent.cpp2
-rw-r--r--src/doc/src/qt3d-overview.qdoc2
-rw-r--r--src/extras/defaults/qt3dwindow.cpp2
-rw-r--r--src/logic/qframeaction.cpp1
-rw-r--r--src/render/frontend/qrenderaspect.cpp1
5 files changed, 6 insertions, 2 deletions
diff --git a/src/core/nodes/qcomponent.cpp b/src/core/nodes/qcomponent.cpp
index e678880e8..5ca49ff30 100644
--- a/src/core/nodes/qcomponent.cpp
+++ b/src/core/nodes/qcomponent.cpp
@@ -112,7 +112,7 @@ void QComponentPrivate::removeEntity(QEntity *entity)
*/
/*!
- \fn Qt3DCore::QComponent::addedToEntity(Qt3DCore::QEntity *entity)'
+ \fn Qt3DCore::QComponent::addedToEntity(Qt3DCore::QEntity *entity)
Indicates that a reference has been added to \a entity.
*/
diff --git a/src/doc/src/qt3d-overview.qdoc b/src/doc/src/qt3d-overview.qdoc
index ec78791d6..aaf246203 100644
--- a/src/doc/src/qt3d-overview.qdoc
+++ b/src/doc/src/qt3d-overview.qdoc
@@ -60,7 +60,7 @@
\li Multitexturing
\li \l {Instanced Rendering}{Instanced rendering}
\li \l {Uniform Buffer Objects}
- \li \l {Pro Tips}
+ \li \l {Qt 3D Render Pro Tips}{Pro Tips}
\endlist
\section2 Materials
diff --git a/src/extras/defaults/qt3dwindow.cpp b/src/extras/defaults/qt3dwindow.cpp
index c3565e416..2df4716dd 100644
--- a/src/extras/defaults/qt3dwindow.cpp
+++ b/src/extras/defaults/qt3dwindow.cpp
@@ -240,6 +240,8 @@ void Qt3DWindow::resizeEvent(QResizeEvent *)
}
/*!
+ \reimp
+
Requests renderer to redraw if we are using OnDemand render policy.
*/
bool Qt3DWindow::event(QEvent *e)
diff --git a/src/logic/qframeaction.cpp b/src/logic/qframeaction.cpp
index 915fb015a..77cdae943 100644
--- a/src/logic/qframeaction.cpp
+++ b/src/logic/qframeaction.cpp
@@ -52,6 +52,7 @@ QFrameActionPrivate::QFrameActionPrivate()
/*!
\namespace Qt3DLogic::Logic
+ \inmodule Qt3DLogic
\brief Used to import and use the module's QML types.
*/
diff --git a/src/render/frontend/qrenderaspect.cpp b/src/render/frontend/qrenderaspect.cpp
index f5c01dd75..ae84599e8 100644
--- a/src/render/frontend/qrenderaspect.cpp
+++ b/src/render/frontend/qrenderaspect.cpp
@@ -182,6 +182,7 @@ namespace Qt3DRender {
/*!
\namespace Qt3DRender::Render
+ \inmodule Qt3DRender
\brief Namespace used for accessing the classes
Renderer and QRenderPlugin.