summaryrefslogtreecommitdiffstats
path: root/src/render/framegraph/qframegraph.cpp
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2015-11-04 12:47:51 +0100
committerTopi Reiniƶ <topi.reinio@theqtcompany.com>2015-11-23 14:15:40 +0000
commit85ffad3142cd4c3baa0bb77b0674a17287b01534 (patch)
treed0ab865a944d837b965546248b19e1ab69e99a82 /src/render/framegraph/qframegraph.cpp
parented9628c87fac466ee6106d12996373ddf56f2c73 (diff)
Doc: Fix QDoc warnings and do further cleanup
Fix the documentation issues that still remained broken after renaming the namespaces/QML modules. Do further cleanup and minor doc editing. Change-Id: Iff38c8c1b99e7f712dc3f9ad07ecd37a747b3a26 Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Diffstat (limited to 'src/render/framegraph/qframegraph.cpp')
-rw-r--r--src/render/framegraph/qframegraph.cpp17
1 files changed, 10 insertions, 7 deletions
diff --git a/src/render/framegraph/qframegraph.cpp b/src/render/framegraph/qframegraph.cpp
index 080d83e48..c1a338211 100644
--- a/src/render/framegraph/qframegraph.cpp
+++ b/src/render/framegraph/qframegraph.cpp
@@ -56,13 +56,13 @@ QFrameGraphPrivate::QFrameGraphPrivate()
}
/*!
- \class FrameGraph
- \inmodule Qt3DRenderer
+ \class Qt3DRender::QFrameGraph
+ \inmodule Qt3DRender
\since 5.3
- \brief Defines the rendering method to be used by the renderer
+ \brief Defines the rendering method to be used by the renderer.
- FrameGraph is the Component that has an activeFrameGraph property
+ QFrameGraph is the Component that has an activeFrameGraph property
that should reference the root FrameGraphItem of a frame graph
tree. The Entity that contains a FrameGraph property defines the
rendering method to be used by the renderer.
@@ -79,7 +79,9 @@ QFrameGraphPrivate::QFrameGraphPrivate()
\brief For OpenGL ...
*/
-/*! \fn void Qt3DRender::QFrameGraph::copy(const QNode *ref)
+/*!
+ \fn void Qt3DRender::QFrameGraph::copy(const Qt3DCore::QNode *ref)
+
Copies the \a ref instance into this one.
*/
void QFrameGraph::copy(const QNode *ref)
@@ -90,7 +92,8 @@ void QFrameGraph::copy(const QNode *ref)
}
/*!
- \fn Qt3DRender::QFrameGraph::QFrameGraph(QNode *parent)
+ \fn Qt3DRender::QFrameGraph::QFrameGraph(Qt3DCore::QNode *parent)
+
Constructs a new QFrameGraph with the specified \a parent.
*/
QFrameGraph::QFrameGraph(QNode *parent)
@@ -110,7 +113,7 @@ QFrameGraph::QFrameGraph(QFrameGraphPrivate &dd, QNode *parent)
}
/*!
- \qmlproperty Qt3D.Renderer::FrameGraphNode Qt3D.Renderer::FrameGraph::activeFrameGraph
+ \qmlproperty FrameGraphNode Qt3D.Render::FrameGraph::activeFrameGraph
Holds the current activeFrameGraph root node.
*/