summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorFriedemann Kleint <Friedemann.Kleint@qt.io>2019-08-13 12:47:05 +0200
committerFriedemann Kleint <Friedemann.Kleint@qt.io>2019-08-13 13:40:22 +0200
commitbb5caa526c242e68ae9ba5cd64933f7f3dea1aef (patch)
tree23b24b0417017591e68356d14ee2df9f9c430ce2 /src
parent87abbae2f16bae53aff6b2e41658bafbef642a95 (diff)
Fix some qdoc warnings
src/render/materialsystem/qshaderimage.cpp:315: (qdoc) warning: Unexpected '\endlist' src/render/materialsystem/qshaderimage.cpp:342: (qdoc) warning: Missing '\endtable' src/render/materialsystem/qshaderimage.cpp:731: (qdoc) warning: Unknown command '\defaut' src/render/materialsystem/qshaderprogrambuilder.cpp:361: (qdoc) warning: Unrecognizable QML module/component qualifier for string ShaderProgramBuilder:vertexShaderCode src/render/materialsystem/qshaderprogrambuilder.cpp:361: (qdoc) warning: Unrecognizable QML module/component qualifier for string ShaderProgramBuilder:vertexShaderCode src/render/materialsystem/qshaderprogrambuilder.cpp:367: (qdoc) warning: Cannot find 'QShaderProgram:Builder:vertexShaderCode' specified with '\property' in any header file src/render/materialsystem/qshaderprogrambuilder.cpp:379: (qdoc) warning: Unrecognizable QML module/component qualifier for string ShaderProgramBuilder:tessellationControlShaderCode src/render/materialsystem/qshaderprogrambuilder.cpp:379: (qdoc) warning: Unrecognizable QML module/component qualifier for string ShaderProgramBuilder:tessellationControlShaderCode src/render/materialsystem/qshaderprogrambuilder.cpp:385: (qdoc) warning: Cannot find 'QShaderProgram:Builder:tessellationControlShaderCode' specified with '\property' in any header file src/render/materialsystem/qshaderprogrambuilder.cpp:397: (qdoc) warning: Unrecognizable QML module/component qualifier for string ShaderProgramBuilder:tessellationEvaluationShaderCode src/render/materialsystem/qshaderprogrambuilder.cpp:397: (qdoc) warning: Unrecognizable QML module/component qualifier for string ShaderProgramBuilder:tessellationEvaluationShaderCode src/render/materialsystem/qshaderprogrambuilder.cpp:403: (qdoc) warning: Cannot find 'QShaderProgram:Builder:tessellationEvaluationShaderCode' specified with '\property' in any header file src/render/materialsystem/qshaderprogrambuilder.cpp:415: (qdoc) warning: Unrecognizable QML module/component qualifier for string ShaderProgramBuilder:geometryShaderCode src/render/materialsystem/qshaderprogrambuilder.cpp:415: (qdoc) warning: Unrecognizable QML module/component qualifier for string ShaderProgramBuilder:geometryShaderCode src/render/materialsystem/qshaderprogrambuilder.cpp:421: (qdoc) warning: Cannot find 'QShaderProgram:Builder:geometryShaderCode' specified with '\property' in any header file src/render/materialsystem/qshaderprogrambuilder.cpp:439: (qdoc) warning: Cannot find 'QShaderProgram:Builder:fragmentShaderCode' specified with '\property' in any header file src/render/materialsystem/qshaderprogrambuilder.cpp:457: (qdoc) warning: Cannot find 'QShaderProgram:Builder:computeShaderCode' specified with '\property' in any header file src/render/texture/qtexture.cpp:1610: (qdoc) warning: Class QSharedGLTexture has no \inmodule command; using project name by default: Qt3D src/render/texture/qtexturedataupdate.cpp:82: (qdoc) warning: Class QTextureDataUpdate has no \inmodule command; using project name by default: Qt3D src/render/materialsystem/qshaderimage.cpp:413: (qdoc) warning: '\brief' statement does not end with a full stop. src/render/frontend/qpickingsettings.cpp:194: (qdoc) warning: No such enum item 'PriorityPick' in Qt3DRender::QPickingSettings::PickResultMode src/render/materialsystem/qshaderimage.cpp:413: (qdoc) warning: '\brief' statement does not end with a full stop. src/render/materialsystem/qshaderimage.cpp:734: (qdoc) warning: Can't link to 'OpenG specifications' src/render/materialsystem/qshaderimage.cpp:63: (qdoc) warning: '\brief' statement does not end with a full stop. Change-Id: Id7a2752895b2a889a6aefdbabac42d4502dc5b7b Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src')
-rw-r--r--src/render/frontend/qpickingsettings.cpp2
-rw-r--r--src/render/materialsystem/qshaderimage.cpp16
-rw-r--r--src/render/materialsystem/qshaderprogrambuilder.cpp20
-rw-r--r--src/render/texture/qtexture.cpp1
-rw-r--r--src/render/texture/qtexturedataupdate.cpp1
5 files changed, 21 insertions, 19 deletions
diff --git a/src/render/frontend/qpickingsettings.cpp b/src/render/frontend/qpickingsettings.cpp
index 84e61e141..0c858aef2 100644
--- a/src/render/frontend/qpickingsettings.cpp
+++ b/src/render/frontend/qpickingsettings.cpp
@@ -199,7 +199,7 @@ void QPickingSettings::setPickMethod(QPickingSettings::PickMethod pickMethod)
* \value NearestPick Only the nearest entity to picking ray origin intersected by the picking ray
* is picked (default).
* \value AllPicks All entities that intersect the picking ray are picked.
- * \value PriorityPick Selects the entity whose object picker has the highest
+ * \value NearestPriorityPick Selects the entity whose object picker has the highest
* value. If several object pickers have the same priority, the closest one on
* the ray is selected.
*
diff --git a/src/render/materialsystem/qshaderimage.cpp b/src/render/materialsystem/qshaderimage.cpp
index f7b3d897b..f2ce04c3d 100644
--- a/src/render/materialsystem/qshaderimage.cpp
+++ b/src/render/materialsystem/qshaderimage.cpp
@@ -65,7 +65,7 @@ QShaderImagePrivate::~QShaderImagePrivate()
\instantiates Qt3DRender::QShaderImage
\inqmlmodule Qt3D.Render
\since 5.14
- \brief Provides Image access to shader programs
+ \brief Provides Image access to shader programs.
To make the content of textures available for read and write operations in
a shader, they need to exposed as ShaderImage. Textures can be composed of
@@ -312,7 +312,7 @@ QShaderImagePrivate::~QShaderImagePrivate()
\li uimageCubeArray
\li GL_UNSIGNED_INT_IMAGE_CUBE_MAP_ARRAY
\li TextureCubeMapArray
- \endlist
+ \endtable
Expected use would look like:
@@ -400,8 +400,8 @@ QShaderImagePrivate::~QShaderImagePrivate()
It however has to be compatible (matching in size but not necessarily by
class type). For instance a texture of format R32F (size 32bits, class
1x32) could be used with an image of format RGBA8I (size 32bits, class
- 4x8). Table 8.27 of the \l {OpenG specifications}
- {https://www.khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf}
+ 4x8). Table 8.27 of the
+ \l{https://www.khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf}{OpenGL specifications}
shows the size and class for all supported image formats.
By default Qt3D will try to set the image format to match that of the
@@ -414,7 +414,7 @@ QShaderImagePrivate::~QShaderImagePrivate()
\class Qt3DRender::QShaderImage
\inmodule Qt3DRender
\since 5.14
- \brief Provides Image access to shader programs
+ \brief Provides Image access to shader programs.
To make the content of textures available for read and write operations in
a shader, they need to exposed as QShaderImage. Textures can be composed of
@@ -728,7 +728,7 @@ QShaderImagePrivate::~QShaderImagePrivate()
the image. If a shader tries to write or read from an image that has
incompatible access, the behavior is undefined.
- \defaut QShaderImage::ReadWrite
+ \default QShaderImage::ReadWrite
*/
/*!
@@ -741,8 +741,8 @@ QShaderImagePrivate::~QShaderImagePrivate()
It however has to be compatible (matching in size but not necessarily by
class type). For instance a texture of format R32F (size 32bits, class
1x32) could be used with an image of format RGBA8I (size 32bits, class
- 4x8). Table 8.27 of the \l {OpenG specifications}
- {https://www.khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf}
+ 4x8). Table 8.27 of the
+ \l{https://www.khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf}{OpenGL specifications}
shows the size and class for all supported Image formats.
By default Qt3D will try to set the image format to match that of the
diff --git a/src/render/materialsystem/qshaderprogrambuilder.cpp b/src/render/materialsystem/qshaderprogrambuilder.cpp
index 84dd33372..cafe23ee4 100644
--- a/src/render/materialsystem/qshaderprogrambuilder.cpp
+++ b/src/render/materialsystem/qshaderprogrambuilder.cpp
@@ -359,13 +359,13 @@ QUrl QShaderProgramBuilder::computeShaderGraph() const
}
/*!
- \qmlproperty string ShaderProgramBuilder:vertexShaderCode
+ \qmlproperty string ShaderProgramBuilder::vertexShaderCode
Holds the generated vertex shader code
\since 2.13
*/
/*!
- \property QShaderProgram:Builder:vertexShaderCode
+ \property QShaderProgramBuilder::vertexShaderCode
Holds the generate vertex shader code.
\since 5.13
@@ -377,13 +377,13 @@ QByteArray QShaderProgramBuilder::vertexShaderCode() const
}
/*!
- \qmlproperty string ShaderProgramBuilder:tessellationControlShaderCode
+ \qmlproperty string ShaderProgramBuilder::tessellationControlShaderCode
Holds the generated tessellation control shader code
\since 2.13
*/
/*!
- \property QShaderProgram:Builder:tessellationControlShaderCode
+ \property QShaderProgramBuilder::tessellationControlShaderCode
Holds the generate tessellation control shader code.
\since 5.13
@@ -395,13 +395,13 @@ QByteArray QShaderProgramBuilder::tessellationControlShaderCode() const
}
/*!
- \qmlproperty string ShaderProgramBuilder:tessellationEvaluationShaderCode
+ \qmlproperty string ShaderProgramBuilder::tessellationEvaluationShaderCode
Holds the generated tessellation evaluation shader code
\since 2.13
*/
/*!
- \property QShaderProgram:Builder:tessellationEvaluationShaderCode
+ \property QShaderProgramBuilder::tessellationEvaluationShaderCode
Holds the generate tessellation evaluation shader code.
\since 5.13
@@ -413,13 +413,13 @@ QByteArray QShaderProgramBuilder::tessellationEvaluationShaderCode() const
}
/*!
- \qmlproperty string ShaderProgramBuilder:geometryShaderCode
+ \qmlproperty string ShaderProgramBuilder::geometryShaderCode
Holds the generated geometry shader code
\since 2.13
*/
/*!
- \property QShaderProgram:Builder:geometryShaderCode
+ \property QShaderProgramBuilder::geometryShaderCode
Holds the generate geometry shader code.
\since 5.13
@@ -437,7 +437,7 @@ QByteArray QShaderProgramBuilder::geometryShaderCode() const
\since 2.13
*/
/*!
- \property QShaderProgram:Builder:fragmentShaderCode
+ \property QShaderProgramBuilder::fragmentShaderCode
Holds the generate fragment shader code.
\since 5.13
@@ -455,7 +455,7 @@ QByteArray QShaderProgramBuilder::fragmentShaderCode() const
\since 2.13
*/
/*!
- \property QShaderProgram:Builder:computeShaderCode
+ \property QShaderProgramBuilder::computeShaderCode
Holds the generate compute shader code.
\since 5.13
diff --git a/src/render/texture/qtexture.cpp b/src/render/texture/qtexture.cpp
index fb9b542ca..5a6adece3 100644
--- a/src/render/texture/qtexture.cpp
+++ b/src/render/texture/qtexture.cpp
@@ -1609,6 +1609,7 @@ bool QTextureFromSourceGenerator::isMirrored() const
/*!
* \class QSharedGLTexture
+ * \inmodule Qt3DRender
* \brief Allows to use a textureId from a separate OpenGL context in a Qt 3D scene.
*
* Depending on the rendering mode used by Qt 3D, the shared context will either be:
diff --git a/src/render/texture/qtexturedataupdate.cpp b/src/render/texture/qtexturedataupdate.cpp
index 35d5682f0..0771291d7 100644
--- a/src/render/texture/qtexturedataupdate.cpp
+++ b/src/render/texture/qtexturedataupdate.cpp
@@ -81,6 +81,7 @@ bool QTextureDataUpdatePrivate::operator!=(const QTextureDataUpdatePrivate &othe
/*!
\class Qt3DRender::QTextureDataUpdate
+ \inmodule Qt3DRender
\brief QTextureDataUpdate holds content and information required to perform
partial updates of a texture content.