summaryrefslogtreecommitdiffstats
path: root/src/render/renderstates
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/renderstates
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/renderstates')
-rw-r--r--src/render/renderstates/qblendstate.cpp32
-rw-r--r--src/render/renderstates/qclipplane.cpp2
-rw-r--r--src/render/renderstates/qcolormask.cpp10
3 files changed, 22 insertions, 22 deletions
diff --git a/src/render/renderstates/qblendstate.cpp b/src/render/renderstates/qblendstate.cpp
index c507e9a5e..bc75aa3ce 100644
--- a/src/render/renderstates/qblendstate.cpp
+++ b/src/render/renderstates/qblendstate.cpp
@@ -66,7 +66,7 @@ public:
/*!
\class Qt3DRender::QBlendState
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
\brief Encapsulates blending information.
*/
@@ -77,7 +77,7 @@ public:
\inherits RenderState
\inqmlmodule Qt3D.Render
\since 5.5
- \brief Encapsulates blending information
+ \brief Encapsulates blending information.
*/
/*!
@@ -93,7 +93,7 @@ QBlendState::~QBlendState()
QNode::cleanup();
}
-/*! \fn void QBlendState::copy(const QNode *ref)
+/*! \fn void QBlendState::copy(const Qt3DCore::QNode *ref)
\internal
Copies \a ref into this object.
*/
@@ -116,7 +116,7 @@ QBlendState::QBlendState(QRenderState::Type type, QNode *parent)
}
/*!
- \enum Qt3DCore::QBlendState::Blending
+ \enum Qt3DRender::QBlendState::Blending
\value Zero 0
\value One 1
@@ -140,12 +140,12 @@ QBlendState::QBlendState(QRenderState::Type type, QNode *parent)
*/
/*!
- \qmlproperty enumeration Qt3D.render::BlendState::srcRGB
+ \qmlproperty enumeration Qt3D.Render::BlendState::srcRGB
*/
/*!
- \property Qt3DCore::QBlendState::srcRGB
+ \property Qt3DRender::QBlendState::srcRGB
*/
QBlendState::Blending QBlendState::srcRGB() const
@@ -164,12 +164,12 @@ void QBlendState::setSrcRGB(QBlendState::Blending srcRGB)
}
/*!
- \qmlproperty enumeration Qt3D.render::BlendState::dstRGB
+ \qmlproperty enumeration Qt3D.Render::BlendState::dstRGB
*/
/*!
- \property Qt3DCore::QBlendState::dstRGB
+ \property Qt3DRender::QBlendState::dstRGB
*/
QBlendState::Blending QBlendState::dstRGB() const
@@ -188,12 +188,12 @@ void QBlendState::setDstRGB(QBlendState::Blending dstRGB)
}
/*!
- \qmlproperty enumeration Qt3D.render::BlendState::srcAlpha
+ \qmlproperty enumeration Qt3D.Render::BlendState::srcAlpha
*/
/*!
- \property Qt3DCore::QBlendState::srcAlpha
+ \property Qt3DRender::QBlendState::srcAlpha
*/
QBlendState::Blending QBlendState::srcAlpha() const
@@ -212,12 +212,12 @@ void QBlendState::setSrcAlpha(QBlendState::Blending srcAlpha)
}
/*!
- \qmlproperty enumeration Qt3D.render::BlendState::dstAlpha
+ \qmlproperty enumeration Qt3D.Render::BlendState::dstAlpha
*/
/*!
- \property Qt3DCore::QBlendState::dstAlpha
+ \property Qt3DRender::QBlendState::dstAlpha
*/
QBlendState::Blending QBlendState::dstAlpha() const
@@ -236,8 +236,8 @@ void QBlendState::setDstAlpha(QBlendState::Blending dstAlpha)
}
/*!
- \class QBlendStateSeparate
- \inmodule Qt3DRenderer
+ \class Qt3DRender::QBlendStateSeparate
+ \inmodule Qt3DRender
\since 5.5
\brief Encapsulates blending information.
*/
@@ -248,11 +248,11 @@ void QBlendState::setDstAlpha(QBlendState::Blending dstAlpha)
\inherits RenderState
\inqmlmodule Qt3D.Render
\since 5.5
- \brief Encapsulates blending information
+ \brief Encapsulates blending information.
*/
/*!
- The constructor creates a QBlendStateSeparate with the
+ The constructor creates a QBlendStateSeparate instance with the
specified \a parent.
*/
QBlendStateSeparate::QBlendStateSeparate(QNode *parent)
diff --git a/src/render/renderstates/qclipplane.cpp b/src/render/renderstates/qclipplane.cpp
index 3850a9dc7..94f2572fd 100644
--- a/src/render/renderstates/qclipplane.cpp
+++ b/src/render/renderstates/qclipplane.cpp
@@ -54,7 +54,7 @@ public:
/*!
\class Qt3DRender::QClipPlane
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\since 5.5
\brief Enables an additional OpenGL clipping plane that can be in shaders
using gl_ClipDistance
diff --git a/src/render/renderstates/qcolormask.cpp b/src/render/renderstates/qcolormask.cpp
index d517d30bc..4c9fabd78 100644
--- a/src/render/renderstates/qcolormask.cpp
+++ b/src/render/renderstates/qcolormask.cpp
@@ -62,7 +62,7 @@ public:
/*!
\class Qt3DRender::QColorMask
- \inmodule Qt3DRenderer
+ \inmodule Qt3DRender
\brief Allows specifying which color components should be written to the
currently bound frame buffer.
@@ -112,7 +112,7 @@ bool QColorMask::isAlpha() const
}
/*!
- \property Qt3DCore::QColorMask::red
+ \property Qt3DRender::QColorMask::red
Holds whether the red color component should be written to the frame buffer.
*/
void QColorMask::setRed(bool red)
@@ -125,7 +125,7 @@ void QColorMask::setRed(bool red)
}
/*!
- \property Qt3DCore::QColorMask::green
+ \property Qt3DRender::QColorMask::green
Holds whether the green color component should be written to the frame buffer.
*/
void QColorMask::setGreen(bool green)
@@ -138,7 +138,7 @@ void QColorMask::setGreen(bool green)
}
/*!
- \property Qt3DCore::QColorMask::blue
+ \property Qt3DRender::QColorMask::blue
Holds whether the blue color component should be written to the frame buffer.
*/
void QColorMask::setBlue(bool blue)
@@ -151,7 +151,7 @@ void QColorMask::setBlue(bool blue)
}
/*!
- \property Qt3DCore::QColorMask::alpha
+ \property Qt3DRender::QColorMask::alpha
Holds whether the alpha component should be written to the frame buffer.
*/
void QColorMask::setAlpha(bool alpha)