summaryrefslogtreecommitdiffstats
path: root/src/render/doc
diff options
context:
space:
mode:
authorSean Harmer <sean.harmer@kdab.com>2015-10-18 09:58:19 +0100
committerSean Harmer <sean.harmer@kdab.com>2015-10-19 10:51:25 +0000
commit18964d9ebed281a72506eccdf26319ce18be46d7 (patch)
tree9c184a8645f0d3ea72fc692f84332fc9be01bf2e /src/render/doc
parentd9ae5577ea87ae23731fe54dd79fd80ecd1de1fa (diff)
Rename Renderer -> Render throughout
This is for consistency between the C++ namespaces and QML imports and with the other aspects. Change-Id: I73392f138b4e519b12888f52530123e3d0ba445e Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
Diffstat (limited to 'src/render/doc')
-rw-r--r--src/render/doc/src/qt3drender-framegraph.qdoc (renamed from src/render/doc/src/qt3drenderer-framegraph.qdoc)6
-rw-r--r--src/render/doc/src/qt3drender-module.qdoc (renamed from src/render/doc/src/qt3drenderer-module.qdoc)28
2 files changed, 17 insertions, 17 deletions
diff --git a/src/render/doc/src/qt3drenderer-framegraph.qdoc b/src/render/doc/src/qt3drender-framegraph.qdoc
index 2fddec27f..52a4e2227 100644
--- a/src/render/doc/src/qt3drenderer-framegraph.qdoc
+++ b/src/render/doc/src/qt3drender-framegraph.qdoc
@@ -35,13 +35,13 @@
****************************************************************************/
/*!
- \page qt3drenderer-framegraph.html
- \title Qt3D Renderer Framegraph
+ \page qt3drender-framegraph.html
+ \title Qt3D Render Framegraph
\brief A framegraph is the data structure that controls how a scene is
rendered.
- The Qt3D Renderer aspect allows for the rendering algorithm to be entirely
+ The Qt3D Render aspect allows for the rendering algorithm to be entirely
data-driven. The controlling data structure is known as the \e framegraph.
Similar to how the Qt3D ECS (entity component system) allows you to define
a so-called Scenegraph by building a scene from a tree of Entities and
diff --git a/src/render/doc/src/qt3drenderer-module.qdoc b/src/render/doc/src/qt3drender-module.qdoc
index 437920301..6e0e8806d 100644
--- a/src/render/doc/src/qt3drenderer-module.qdoc
+++ b/src/render/doc/src/qt3drender-module.qdoc
@@ -35,46 +35,46 @@
****************************************************************************/
/*!
- \module Qt3DRenderer
- \title Qt3D Renderer C++ Classes
- \brief The Qt3D Renderer module contains functionality to support 2D and 3D rendering using Qt3D.
+ \module Qt3DRender
+ \title Qt3D Render C++ Classes
+ \brief The Qt3D Render module contains functionality to support 2D and 3D rendering using Qt3D.
\ingroup modules
\ingroup qt3d-modules
- \qtvariable 3drenderer
+ \qtvariable 3drender
- The Qt3D Renderer module provides an aspect, components, and other supporting types necessary
+ The Qt3D Render module provides an aspect, components, and other supporting types necessary
to implement 2D and 3D rendering as part of the Qt3D framework.
To use classes from this module, add this directive into the C++ files:
\code
- #include <Qt3DRenderer>
+ #include <Qt3DRender>
\endcode
To link against the corresponding C++ library, add the following to your qmake project file:
\badcode
- QT += 3drenderer
+ QT += 3drender
\endcode
- Classes, types, and functions are declared under the \l [Qt3DCore]{Qt3D} namespace.
+ Classes, types, and functions are declared under the \l [Qt3DRender]{Qt3DRender} namespace.
\section1 Overview
- The Qt3D Renderer aspect offers support for data-driven configuration as described
- in \l {Qt3D Renderer Framegraph}.
+ The Qt3D Render aspect offers support for data-driven configuration as described
+ in \l {Qt3D Render Framegraph}.
\section1 Reference
\list
- \li \l {Qt3D Renderer C++ Classes}
+ \li \l {Qt3D Render C++ Classes}
\li \l {Qt3D Examples}
\endlist
*/
/*!
- \qmlmodule Qt3D.Renderer 2.0
- \title Qt3D Renderer QML Types
+ \qmlmodule Qt3D.Render 2.0
+ \title Qt3D Render QML Types
\ingroup qmlmodules
\ingroup qt3d-qmlmodules
@@ -83,6 +83,6 @@
To import and use the module's QML types, use the following statement:
\badcode
- import Qt3D.Renderer 2.0
+ import Qt3D.Render 2.0
\endcode
*/