Add doc to undocumented functions qt3d

Change-Id: Ic5183b31ee0df54e7a99a48f71ac04fc648f92e2
Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
 

5 files changed, 92 insertions, 13 deletions

diff --git a/src/render/framegraph/qblitframebuffer.cpp b/src/render/framegraph/qblitframebuffer.cpp
index b0a29eab8..d0e1bdbf3 100644
--- a/src/render/framegraph/qblitframebuffer.cpp
+++ b/src/render/framegraph/qblitframebuffer.cpp
@@ -64,8 +64,62 @@ namespace Qt3DRender {
     \note In practice the QBlitFramebuffer node will often be used in
     combination with QNoDraw since a blit should not involve issuing draw calls
     for any entities.
+
+*/
+/*!
+    \enum Qt3DRender::QBlitFramebuffer::InterpolationMethod
+
+    Specifies the interpolation applied if the image is stretched.
+
+*/
+/*!
+    \property Qt3DRender::QBlitFramebuffer::destination
+
+    Specifies the destination render target. When not set, the destination
+    is assumed to be the default framebuffer (i.e. the backbuffer of
+    the current surface), if there is one.
+
+    \note the source and destination must not refer to the same render
+          target.
+*/
+/*!
+
+    \property Qt3DRender::QBlitFramebuffer::destinationAttachmentPoint
+
+    Specifies the target attachment point.
+*/
+
+/*!
+    \property Qt3DRender::QBlitFramebuffer::destinationRect
+
+    Specifies the destination rectangle. The coordinates are assumed to follow
+    the normal Qt coordinate system, meaning Y runs from top to bottom.
+*/
+
+/*!
+    \property Qt3DRender::QBlitFramebuffer::source
+
+    Specifies the source render target. When not set, the source is assumed to
+    be the default framebuffer (i.e. the backbuffer of the current surface), if
+    there is one.
+
+    \note the source and destination must not refer to the same render target.
+
+*/
+/*!
+    \property Qt3DRender::QBlitFramebuffer::sourceAttachmentPoint
+
+    Specifies the source attachment point.
+
+*/
+/*!
+    \property Qt3DRender::QBlitFramebuffer::sourceRect
+
+    Specifies the source rectangle. The coordinates are assumed to follow the
+    normal Qt coordinate system, meaning Y runs from top to bottom.
  */
 
+
 /*!
     \qmltype BlitFramebuffer
     \inqmlmodule Qt3D.Render
diff --git a/src/render/frontend/qabstractfunctor.cpp b/src/render/frontend/qabstractfunctor.cpp
index 4be1da595..698c3a291 100644
--- a/src/render/frontend/qabstractfunctor.cpp
+++ b/src/render/frontend/qabstractfunctor.cpp
@@ -58,8 +58,15 @@ namespace Qt3DRender {
  */
 /*!
     \fn qintptr Qt3DRender::QAbstractFunctor::id() const
+
+    Returns a pointer to the id of the functor.
  */
 /*!
+   \fn qintptr Qt3DRender::functorTypeId()
+
+   Returns a pointer to the type id of the functor.
+*/
+/*!
     \macro QT3D_FUNCTOR(Class)
     \relates Qt3DRender::QAbstractFunctor
 
diff --git a/src/render/geometry/attribute.cpp b/src/render/geometry/attribute.cpp
index 6c8c0113a..bc6b27851 100644
--- a/src/render/geometry/attribute.cpp
+++ b/src/render/geometry/attribute.cpp
@@ -100,6 +100,17 @@ void Attribute::initializeFromPeer(const Qt3DCore::QNodeCreatedChangeBasePtr &ch
     m_attributeDirty = true;
 }
 
+/*!
+    \fn Qt3DRender::QAttribute::dataSizeChanged(uint vertexSize)
+
+    The signal is emitted with \a vertexSize when the dataSize changes.
+
+*/
+/*!
+    \fn Qt3DRender::QAttribute::dataTypeChanged(Qt3DRender::QAttribute::VertexBaseType vertexBaseType)
+
+    The signal is emitted with \a vertexBaseType when the dataType changed.
+*/
 void Attribute::sceneChangeEvent(const Qt3DCore::QSceneChangePtr &e)
 {
     switch (e->type()) {
diff --git a/src/render/picking/qabstractraycaster.cpp b/src/render/picking/qabstractraycaster.cpp
index fa48cf0b0..ecec7a628 100644
--- a/src/render/picking/qabstractraycaster.cpp
+++ b/src/render/picking/qabstractraycaster.cpp
@@ -58,6 +58,10 @@ QAbstractRayCasterPrivate::QAbstractRayCasterPrivate()
     m_shareable = false;
 }
 
+/*!
+    \property Qt3DRender::QAbstractRayCaster::Hits
+*/
+
 QAbstractRayCasterPrivate *QAbstractRayCasterPrivate::get(QAbstractRayCaster *obj)
 {
     return obj->d_func();
diff --git a/src/render/texture/qabstracttexture.cpp b/src/render/texture/qabstracttexture.cpp
index ec9456b44..751b6691f 100644
--- a/src/render/texture/qabstracttexture.cpp
+++ b/src/render/texture/qabstracttexture.cpp
@@ -417,7 +417,7 @@ void QAbstractTexture::setDepth(int depth)
 }
 
 /*!
- * \return the width of the texture
+ * Returns the width of the texture
  */
 int QAbstractTexture::width() const
 {
@@ -426,7 +426,7 @@ int QAbstractTexture::width() const
 }
 
 /*!
- * \return the height of the texture
+ * Returns the height of the texture
  */
 int QAbstractTexture::height() const
 {
@@ -435,7 +435,7 @@ int QAbstractTexture::height() const
 }
 
 /*!
- * \return the depth of the texture
+ * Returns the depth of the texture
  */
 int QAbstractTexture::depth() const
 {
@@ -465,7 +465,7 @@ void QAbstractTexture::setLayers(int layers)
 }
 
 /*!
-    \return the maximum number of layers for the texture provider.
+    Returns the maximum number of layers for the texture provider.
 
     \note this has a meaning only for texture providers that have 3D or
      array target formats.
@@ -498,7 +498,7 @@ void QAbstractTexture::setSamples(int samples)
 }
 
 /*!
-    \return the number of samples per texel for the texture provider.
+    Returns the number of samples per texel for the texture provider.
 
     \note this has a meaning only for texture providers that have multisample
     formats.
@@ -592,7 +592,7 @@ void QAbstractTexture::setHandleType(QAbstractTexture::HandleType type)
 }
 
 /*!
- * \return the current status of the texture provider.
+ * Returns the current status of the texture provider.
  */
 QAbstractTexture::Status QAbstractTexture::status() const
 {
@@ -694,7 +694,7 @@ void QAbstractTexture::removeTextureImage(QAbstractTextureImage *textureImage)
 }
 
 /*!
-    \return a list of pointers to QAbstractTextureImage objects contained in
+    Returns a list of pointers to QAbstractTextureImage objects contained in
     the texture provider.
  */
 QVector<QAbstractTextureImage *> QAbstractTexture::textureImages() const
@@ -848,7 +848,7 @@ void QAbstractTexture::setMaximumAnisotropy(float anisotropy)
 }
 
 /*!
- * \return the current maximum anisotropy
+ * Returns the current maximum anisotropy
  */
 float QAbstractTexture::maximumAnisotropy() const
 {
@@ -857,7 +857,7 @@ float QAbstractTexture::maximumAnisotropy() const
 }
 
 /*!
-    \property Qt3DRender::QAbstractTexture::comparisonFunction
+    \property Qt3DRender::QAbstractTexture::ComparisonFunction
 
     Holds the comparison function of the texture provider.
  */
@@ -874,7 +874,7 @@ void QAbstractTexture::setComparisonFunction(QAbstractTexture::ComparisonFunctio
 }
 
 /*!
- * \return the current comparison function.
+ * Returns the current comparison function.
  */
 QAbstractTexture::ComparisonFunction QAbstractTexture::comparisonFunction() const
 {
@@ -883,7 +883,7 @@ QAbstractTexture::ComparisonFunction QAbstractTexture::comparisonFunction() cons
 }
 
 /*!
-    \property Qt3DRender::QAbstractTexture::comparisonMode
+    \property Qt3DRender::QAbstractTexture::ComparisonMode
 
     Holds the comparison mode of the texture provider.
  */
@@ -900,7 +900,7 @@ void QAbstractTexture::setComparisonMode(QAbstractTexture::ComparisonMode mode)
 }
 
 /*!
- * \return the current comparison mode.
+ * Returns the current comparison mode.
  */
 QAbstractTexture::ComparisonMode QAbstractTexture::comparisonMode() const
 {
@@ -909,7 +909,7 @@ QAbstractTexture::ComparisonMode QAbstractTexture::comparisonMode() const
 }
 
 /*!
- * \return the current data generator.
+ * Returns the current data generator.
  */
 QTextureGeneratorPtr QAbstractTexture::dataGenerator() const
 {
@@ -993,6 +993,9 @@ Qt3DCore::QNodeCreatedChangeBasePtr QAbstractTexture::createNodeCreationChange()
     return creationChange;
 }
 
+/*!
+    A function for receiving and processing a \a change.
+*/
 void QAbstractTexture::sceneChangeEvent(const Qt3DCore::QSceneChangePtr &change)
 {
     switch (change->type()) {