summaryrefslogtreecommitdiffstats
path: root/src/render/renderstates
diff options
context:
space:
mode:
authorLuca Di Sera <luca.disera@qt.io>2024-02-12 21:00:37 +0100
committerLuca Di Sera <luca.disera@qt.io>2024-02-13 13:28:57 +0100
commit885ab2894b2418365b24a2cb66fd49ab22969266 (patch)
tree4a2d11a6f5074f70013345794a5be911e373bf12 /src/render/renderstates
parent5ba9e32dd800429dcaa0367d9ebb695ca91f3408 (diff)
Doc: Fully qualify \property, \qmlproperty, \typedef, \enum
Upcoming changes to QDoc require API entities to be fully qualified; previously, QDoc maintained a list of 'open namespaces' that were part of matching the documented entity with its declaration, but that concept does not work for parallelized parsing where the order of processing can be arbitrary. Change-Id: I1662fb4692b5c91a2d9e33eb17708544d9cd1ebb Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'src/render/renderstates')
-rw-r--r--src/render/renderstates/qalphatest.cpp4
-rw-r--r--src/render/renderstates/qblendequation.cpp2
-rw-r--r--src/render/renderstates/qblendequationarguments.cpp10
-rw-r--r--src/render/renderstates/qclipplane.cpp6
-rw-r--r--src/render/renderstates/qcolormask.cpp8
-rw-r--r--src/render/renderstates/qcullface.cpp2
-rw-r--r--src/render/renderstates/qdepthrange.cpp4
-rw-r--r--src/render/renderstates/qdepthtest.cpp2
-rw-r--r--src/render/renderstates/qfrontface.cpp4
-rw-r--r--src/render/renderstates/qlinewidth.cpp2
-rw-r--r--src/render/renderstates/qpointsize.cpp4
-rw-r--r--src/render/renderstates/qpolygonoffset.cpp4
-rw-r--r--src/render/renderstates/qrastermode.cpp4
-rw-r--r--src/render/renderstates/qscissortest.cpp8
-rw-r--r--src/render/renderstates/qstencilmask.cpp4
-rw-r--r--src/render/renderstates/qstenciloperation.cpp4
-rw-r--r--src/render/renderstates/qstenciloperationarguments.cpp8
-rw-r--r--src/render/renderstates/qstenciltest.cpp4
-rw-r--r--src/render/renderstates/qstenciltestarguments.cpp8
19 files changed, 46 insertions, 46 deletions
diff --git a/src/render/renderstates/qalphatest.cpp b/src/render/renderstates/qalphatest.cpp
index 14a64a227..65fda1d79 100644
--- a/src/render/renderstates/qalphatest.cpp
+++ b/src/render/renderstates/qalphatest.cpp
@@ -72,12 +72,12 @@ namespace Qt3DRender {
*/
/*!
- \property QAlphaTest::alphaFunction
+ \property Qt3DRender::QAlphaTest::alphaFunction
Holds the alpha function used by the alpha test. Default is Never.
*/
/*!
- \property QAlphaTest::referenceValue
+ \property Qt3DRender::QAlphaTest::referenceValue
Holds the reference value used by the alpha test. Default is 0.0.
When set, the value is clamped between 0 and 1.
*/
diff --git a/src/render/renderstates/qblendequation.cpp b/src/render/renderstates/qblendequation.cpp
index 0e1ce7d3c..45055cea2 100644
--- a/src/render/renderstates/qblendequation.cpp
+++ b/src/render/renderstates/qblendequation.cpp
@@ -65,7 +65,7 @@ QBlendEquation::~QBlendEquation()
*/
/*!
- \property QBlendEquation::blendFunction
+ \property Qt3DRender::QBlendEquation::blendFunction
Holds the blend function, which determines how source and destination colors are combined.
*/
diff --git a/src/render/renderstates/qblendequationarguments.cpp b/src/render/renderstates/qblendequationarguments.cpp
index 3b3b94787..a2a625151 100644
--- a/src/render/renderstates/qblendequationarguments.cpp
+++ b/src/render/renderstates/qblendequationarguments.cpp
@@ -94,7 +94,7 @@ QBlendEquationArguments::QBlendEquationArguments(QBlendEquationArgumentsPrivate
*/
/*!
- \property QBlendEquationArguments::sourceRgb
+ \property Qt3DRender::QBlendEquationArguments::sourceRgb
*/
QBlendEquationArguments::Blending QBlendEquationArguments::sourceRgb() const
@@ -121,7 +121,7 @@ void QBlendEquationArguments::setSourceRgb(QBlendEquationArguments::Blending sou
*/
/*!
- \property QBlendEquationArguments::destinationRgb
+ \property Qt3DRender::QBlendEquationArguments::destinationRgb
*/
QBlendEquationArguments::Blending QBlendEquationArguments::destinationRgb() const
@@ -148,7 +148,7 @@ void QBlendEquationArguments::setDestinationRgb(QBlendEquationArguments::Blendin
*/
/*!
- \property QBlendEquationArguments::sourceAlpha
+ \property Qt3DRender::QBlendEquationArguments::sourceAlpha
*/
QBlendEquationArguments::Blending QBlendEquationArguments::sourceAlpha() const
@@ -175,7 +175,7 @@ void QBlendEquationArguments::setSourceAlpha(QBlendEquationArguments::Blending s
*/
/*!
- \property QBlendEquationArguments::destinationAlpha
+ \property Qt3DRender::QBlendEquationArguments::destinationAlpha
*/
QBlendEquationArguments::Blending QBlendEquationArguments::destinationAlpha() const
@@ -234,7 +234,7 @@ void QBlendEquationArguments::setDestinationRgba(Blending destinationRgba)
*/
/*!
- \property QBlendEquationArguments::bufferIndex
+ \property Qt3DRender::QBlendEquationArguments::bufferIndex
Specifies the index of the Draw Buffer that this BlendEquationArguments applies to.
If negative, this will apply to all Draw Buffers.
diff --git a/src/render/renderstates/qclipplane.cpp b/src/render/renderstates/qclipplane.cpp
index 256331a56..d58d3bcb7 100644
--- a/src/render/renderstates/qclipplane.cpp
+++ b/src/render/renderstates/qclipplane.cpp
@@ -56,18 +56,18 @@ namespace Qt3DRender {
/*!
- \property QClipPlane::planeIndex
+ \property Qt3DRender::QClipPlane::planeIndex
Holds the index of the plane.
\note Usually between 0-7.
*/
/*!
- \property QClipPlane::normal
+ \property Qt3DRender::QClipPlane::normal
Holds the normal of the plane.
*/
/*!
- \property QClipPlane::distance
+ \property Qt3DRender::QClipPlane::distance
Holds the distance of the plane from the world origin.
*/
diff --git a/src/render/renderstates/qcolormask.cpp b/src/render/renderstates/qcolormask.cpp
index 67906937c..e49b47b7e 100644
--- a/src/render/renderstates/qcolormask.cpp
+++ b/src/render/renderstates/qcolormask.cpp
@@ -95,7 +95,7 @@ bool QColorMask::isAlphaMasked() const
}
/*!
- \property QColorMask::redMasked
+ \property Qt3DRender::QColorMask::redMasked
Holds whether the red color component should be written to the frame buffer.
*/
void QColorMask::setRedMasked(bool redMasked)
@@ -108,7 +108,7 @@ void QColorMask::setRedMasked(bool redMasked)
}
/*!
- \property QColorMask::greenMasked
+ \property Qt3DRender::QColorMask::greenMasked
Holds whether the green color component should be written to the frame buffer.
*/
void QColorMask::setGreenMasked(bool greenMasked)
@@ -121,7 +121,7 @@ void QColorMask::setGreenMasked(bool greenMasked)
}
/*!
- \property QColorMask::blueMasked
+ \property Qt3DRender::QColorMask::blueMasked
Holds whether the blue color component should be written to the frame buffer.
*/
void QColorMask::setBlueMasked(bool blueMasked)
@@ -134,7 +134,7 @@ void QColorMask::setBlueMasked(bool blueMasked)
}
/*!
- \property QColorMask::alphaMasked
+ \property Qt3DRender::QColorMask::alphaMasked
Holds whether the alphaMasked component should be written to the frame buffer.
*/
void QColorMask::setAlphaMasked(bool alphaMasked)
diff --git a/src/render/renderstates/qcullface.cpp b/src/render/renderstates/qcullface.cpp
index 27880241b..7911b935b 100644
--- a/src/render/renderstates/qcullface.cpp
+++ b/src/render/renderstates/qcullface.cpp
@@ -121,7 +121,7 @@ namespace Qt3DRender {
*/
/*!
- \property QCullFace::mode
+ \property Qt3DRender::QCullFace::mode
Holds the culling mode used by QCullFace. Default is set to QCullFace.Back.
*/
diff --git a/src/render/renderstates/qdepthrange.cpp b/src/render/renderstates/qdepthrange.cpp
index 12215b834..75e0c49f3 100644
--- a/src/render/renderstates/qdepthrange.cpp
+++ b/src/render/renderstates/qdepthrange.cpp
@@ -53,13 +53,13 @@ namespace Qt3DRender {
*/
/*!
- \property QDepthRange::nearValue
+ \property Qt3DRender::QDepthRange::nearValue
The depth buffer value corresponding to the near clip plane. Valid values for are
between 0 and 1.
*/
/*!
- \property QDepthRange::farValue
+ \property Qt3DRender::QDepthRange::farValue
The depth buffer value corresponding to the far clip plane. Valid values for are
between 0 and 1.
*/
diff --git a/src/render/renderstates/qdepthtest.cpp b/src/render/renderstates/qdepthtest.cpp
index 52d0cbc25..4e4c3da3e 100644
--- a/src/render/renderstates/qdepthtest.cpp
+++ b/src/render/renderstates/qdepthtest.cpp
@@ -76,7 +76,7 @@ namespace Qt3DRender {
*/
/*!
- \property QDepthTest::depthFunction
+ \property Qt3DRender::QDepthTest::depthFunction
Holds the current function used by depth test. The default is Never.
*/
diff --git a/src/render/renderstates/qfrontface.cpp b/src/render/renderstates/qfrontface.cpp
index 22165ea09..012dd7ba7 100644
--- a/src/render/renderstates/qfrontface.cpp
+++ b/src/render/renderstates/qfrontface.cpp
@@ -36,7 +36,7 @@ namespace Qt3DRender {
*/
/*!
- \enum QFrontFace::WindingDirection
+ \enum Qt3DRender::QFrontFace::WindingDirection
This enumeration specifies the winding direction values.
\value ClockWise Clockwise polygons are front facing.
@@ -49,7 +49,7 @@ namespace Qt3DRender {
*/
/*!
- \property QFrontFace::direction
+ \property Qt3DRender::QFrontFace::direction
Holds the winding direction of the front facing polygons. Default is Clockwise.
*/
diff --git a/src/render/renderstates/qlinewidth.cpp b/src/render/renderstates/qlinewidth.cpp
index 8a7b8e4d9..47231acd0 100644
--- a/src/render/renderstates/qlinewidth.cpp
+++ b/src/render/renderstates/qlinewidth.cpp
@@ -31,7 +31,7 @@ namespace Qt3DRender {
*/
/*!
- \property QLineWidth::value
+ \property Qt3DRender::QLineWidth::value
Specifies the width value to be used.
*/
diff --git a/src/render/renderstates/qpointsize.cpp b/src/render/renderstates/qpointsize.cpp
index fb1a7c9e4..621486d87 100644
--- a/src/render/renderstates/qpointsize.cpp
+++ b/src/render/renderstates/qpointsize.cpp
@@ -55,12 +55,12 @@ namespace Qt3DRender {
*/
/*!
- \property QPointSize::value
+ \property Qt3DRender::QPointSize::value
Specifies the point size value to be used.
*/
/*!
- \property QPointSize::sizeMode
+ \property Qt3DRender::QPointSize::sizeMode
Specifies the sizeMode to be used.
*/
diff --git a/src/render/renderstates/qpolygonoffset.cpp b/src/render/renderstates/qpolygonoffset.cpp
index 6cafcdace..f0b108380 100644
--- a/src/render/renderstates/qpolygonoffset.cpp
+++ b/src/render/renderstates/qpolygonoffset.cpp
@@ -48,13 +48,13 @@ namespace Qt3DRender {
*/
/*!
- \property QPolygonOffset::scaleFactor
+ \property Qt3DRender::QPolygonOffset::scaleFactor
Holds the scale factor used to create a variable depth offset for
each polygon. Default value is 0.
*/
/*!
- \property QPolygonOffset::depthSteps
+ \property Qt3DRender::QPolygonOffset::depthSteps
Holds the units that create constant depth offsets. Default value is 0.
*/
diff --git a/src/render/renderstates/qrastermode.cpp b/src/render/renderstates/qrastermode.cpp
index 93de5d2fb..4298389c3 100644
--- a/src/render/renderstates/qrastermode.cpp
+++ b/src/render/renderstates/qrastermode.cpp
@@ -63,13 +63,13 @@ namespace Qt3DRender {
*/
/*!
- \property QRasterMode::rasterMode
+ \property Qt3DRender::QRasterMode::rasterMode
Holds the raster mode to be used.
*/
/*!
- \property QRasterMode::faceMode
+ \property Qt3DRender::QRasterMode::faceMode
Holds the face mode to be used. Controls on which face the raster mode is
to be applied.
diff --git a/src/render/renderstates/qscissortest.cpp b/src/render/renderstates/qscissortest.cpp
index 067ae1415..cc7b236fb 100644
--- a/src/render/renderstates/qscissortest.cpp
+++ b/src/render/renderstates/qscissortest.cpp
@@ -58,22 +58,22 @@ namespace Qt3DRender {
*/
/*!
- \property QScissorTest::left
+ \property Qt3DRender::QScissorTest::left
Holds the left coordinate of the scissor box.
*/
/*!
- \property QScissorTest::bottom
+ \property Qt3DRender::QScissorTest::bottom
Holds the bottom coordinate of the scissor box.
*/
/*!
- \property QScissorTest::width
+ \property Qt3DRender::QScissorTest::width
Holds the width of the scissor box.
*/
/*!
- \property QScissorTest::height
+ \property Qt3DRender::QScissorTest::height
Holds the height of the scissor box.
*/
diff --git a/src/render/renderstates/qstencilmask.cpp b/src/render/renderstates/qstencilmask.cpp
index 7c71fb789..6557d3a68 100644
--- a/src/render/renderstates/qstencilmask.cpp
+++ b/src/render/renderstates/qstencilmask.cpp
@@ -52,12 +52,12 @@ namespace Qt3DRender {
*/
/*!
- \property QStencilMask::frontOutputMask
+ \property Qt3DRender::QStencilMask::frontOutputMask
Holds the write mask for the fragment stencil values for front-facing polygons.
*/
/*!
- \property QStencilMask::backOutputMask
+ \property Qt3DRender::QStencilMask::backOutputMask
Holds the write mask for the fragment stencil values for back-facing polygons.
*/
diff --git a/src/render/renderstates/qstenciloperation.cpp b/src/render/renderstates/qstenciloperation.cpp
index 600696ad1..5daf06ac0 100644
--- a/src/render/renderstates/qstenciloperation.cpp
+++ b/src/render/renderstates/qstenciloperation.cpp
@@ -52,12 +52,12 @@ QStencilOperationPrivate::~QStencilOperationPrivate() = default;
*/
/*!
- \property QStencilOperation::front
+ \property Qt3DRender::QStencilOperation::front
Holds the stencil operation arguments for front-facing polygons.
*/
/*!
- \property QStencilOperation::back
+ \property Qt3DRender::QStencilOperation::back
Holds the stencil operation arguments for back-facing polygons.
*/
diff --git a/src/render/renderstates/qstenciloperationarguments.cpp b/src/render/renderstates/qstenciloperationarguments.cpp
index 69eedbf62..0c4fd5cde 100644
--- a/src/render/renderstates/qstenciloperationarguments.cpp
+++ b/src/render/renderstates/qstenciloperationarguments.cpp
@@ -103,25 +103,25 @@ QStencilOperationArgumentsPrivate::~QStencilOperationArgumentsPrivate() = defaul
*/
/*!
- \property QStencilOperationArguments::faceMode
+ \property Qt3DRender::QStencilOperationArguments::faceMode
Holds the faces the arguments are applied to.
\readonly
*/
/*!
- \property QStencilOperationArguments::stencilTestFailureOperation
+ \property Qt3DRender::QStencilOperationArguments::stencilTestFailureOperation
Holds the stencil test operation for when the stencil test fails.
Default is StencilOperationArguments.Keep.
*/
/*!
- \property QStencilOperationArguments::depthTestFailureOperation
+ \property Qt3DRender::QStencilOperationArguments::depthTestFailureOperation
Holds the stencil test operation for when the stencil test passes, but
depth test fails. Default is StencilOperationArguments.Keep.
*/
/*!
- \property QStencilOperationArguments::allTestsPassOperation
+ \property Qt3DRender::QStencilOperationArguments::allTestsPassOperation
Holds the stencil test operation for when depth and stencil test pass. Default is StencilOperationArguments.Keep.
*/
diff --git a/src/render/renderstates/qstenciltest.cpp b/src/render/renderstates/qstenciltest.cpp
index 8f94afffb..c35d5797d 100644
--- a/src/render/renderstates/qstenciltest.cpp
+++ b/src/render/renderstates/qstenciltest.cpp
@@ -53,12 +53,12 @@ namespace Qt3DRender {
*/
/*!
- \property QStencilTest::front
+ \property Qt3DRender::QStencilTest::front
Holds the stencil test arguments for front-facing polygons.
*/
/*!
- \property QStencilTest::back
+ \property Qt3DRender::QStencilTest::back
Holds the stencil test arguments for back-facing polygons.
*/
diff --git a/src/render/renderstates/qstenciltestarguments.cpp b/src/render/renderstates/qstenciltestarguments.cpp
index fa793ab03..5b8435360 100644
--- a/src/render/renderstates/qstenciltestarguments.cpp
+++ b/src/render/renderstates/qstenciltestarguments.cpp
@@ -92,23 +92,23 @@ namespace Qt3DRender {
*/
/*!
- \property QStencilTestArguments::faceMode
+ \property Qt3DRender::QStencilTestArguments::faceMode
Holds the faces the arguments are applied to.
\readonly
*/
/*!
- \property QStencilTestArguments::comparisonMask
+ \property Qt3DRender::QStencilTestArguments::comparisonMask
Holds the stencil test comparison mask. Default is all zeroes.
*/
/*!
- \property QStencilTestArguments::referenceValue
+ \property Qt3DRender::QStencilTestArguments::referenceValue
Holds the stencil test reference value. Default is zero.
*/
/*!
- \property QStencilTestArguments::stencilFunction
+ \property Qt3DRender::QStencilTestArguments::stencilFunction
Holds the stencil test function. Default is Never.
\sa Qt3DRender::QStencilTestArguments::StencilFunction
*/