From 0b5d01eeec9913a0bb0d545b48d13cec8dde5354 Mon Sep 17 00:00:00 2001
From: Topi Reinio <topi.reinio@qt.io>
Date: Wed, 13 Nov 2019 09:19:05 +0100
Subject: Doc: Fix documentation warnings
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

- Add (basic) documentation for Qt3DAnimation::QAnimationCallback.
- Add missing namespace qualifiers for \class, \fn, \instantiates,
  \sa, and \property commands.
- Remove linking to example file pages, as QDoc no longe treats them
  as linkable targets.
- Fix function/QML method parameter documentation
- Fix missing \qmlproperty types
- Fix linking to QKeyEvent in QtGui.
- Move Qt3DRender::Quick namespace documentation to where QDoc can
  see it.
- Add enum documentation for
  Qt3DRender::QBlitFramebuffer::InterpolationMethod and
  Qt3DRender::QMesh::Status.
- Other minor fixes

This brings the current warning count to zero.

Fixes: QTBUG-79822
Change-Id: I1154a7f9c34917a3f240e99da0e7a300be7d65a0
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
---
 src/render/framegraph/qblitframebuffer.cpp |  4 ++++
 src/render/framegraph/qsetfence.cpp        |  9 +++++----
 src/render/framegraph/qwaitfence.cpp       | 12 ++++++------
 3 files changed, 15 insertions(+), 10 deletions(-)

(limited to 'src/render/framegraph')

diff --git a/src/render/framegraph/qblitframebuffer.cpp b/src/render/framegraph/qblitframebuffer.cpp
index 3a26e3d56..252758af4 100644
--- a/src/render/framegraph/qblitframebuffer.cpp
+++ b/src/render/framegraph/qblitframebuffer.cpp
@@ -70,6 +70,10 @@ namespace Qt3DRender {
 
     Specifies the interpolation applied if the image is stretched.
 
+    \value Nearest
+           Nearest-neighbor interpolation.
+    \value Linear
+           Linear interpolation.
 */
 /*!
     \property Qt3DRender::QBlitFramebuffer::destination
diff --git a/src/render/framegraph/qsetfence.cpp b/src/render/framegraph/qsetfence.cpp
index 5cb82f3db..262dbd4ad 100644
--- a/src/render/framegraph/qsetfence.cpp
+++ b/src/render/framegraph/qsetfence.cpp
@@ -54,7 +54,8 @@ QSetFencePrivate::QSetFencePrivate()
 }
 
 /*!
-    \class QSetFence
+    \class Qt3DRender::QSetFence
+    \inmodule Qt3DRender
     \brief FrameGraphNode used to insert a fence in the graphics command stream.
 
     Fence allow to synchronosize GPU and CPU workloads. GPU commands usually
@@ -100,7 +101,7 @@ QSetFence::QSetFence(QSetFencePrivate &dd, Qt3DCore::QNode *parent)
     are supported.
 */
 /*!
-    \property QSetFence::handleType
+    \property Qt3DRender::QSetFence::handleType
 
     Specifies the type of handle being used. Currently only OpenGL Fence ids
     are supported.
@@ -123,12 +124,12 @@ void QSetFencePrivate::setHandleType(QSetFence::HandleType type)
 }
 
 /*!
-    \qmlproperty variant AbstractFence::handle
+    \qmlproperty variant SetFence::handle
 
     Holds the underlying fence handle wrapped in a variant.
 */
 /*!
-    \property QAbstractFence::handle
+    \property Qt3DRender::QSetFence::handle
 
     Holds the underlying fence handle wrapped in a QVariant.
 */
diff --git a/src/render/framegraph/qwaitfence.cpp b/src/render/framegraph/qwaitfence.cpp
index 5195653ce..737f4e54d 100644
--- a/src/render/framegraph/qwaitfence.cpp
+++ b/src/render/framegraph/qwaitfence.cpp
@@ -56,8 +56,8 @@ QWaitFencePrivate::QWaitFencePrivate()
 }
 
 /*!
-    \class QWaitFence
-
+    \class Qt3DRender::QWaitFence
+    \inmodule Qt3DRender
     \brief FrameGraphNode used to wait for a fence in the graphics command
     stream to become signaled.
 
@@ -98,7 +98,7 @@ QWaitFence::~QWaitFence()
     become signaled. This is false by default.
 */
 /*!
-    \property QWaitFence::waitOnCPU
+    \property Qt3DRender::QWaitFence::waitOnCPU
 
     Specifies whether the CPU should be block while waiting for the fence to
     become signaled. This is false by default.
@@ -125,7 +125,7 @@ void QWaitFence::setWaitOnCPU(bool waitOnCPU)
     to become signaled.
 */
 /*!
-    \property QWaitFence::timeout
+    \property Qt3DRender::QWaitFence::timeout
 
     Specifies the maximum amount of time in nanoseconds to wait for the fence
     to become signaled.
@@ -157,7 +157,7 @@ QWaitFence::QWaitFence(QWaitFencePrivate &dd, Qt3DCore::QNode *parent)
     are supported.
 */
 /*!
-    \property QWaitFence::handleType
+    \property Qt3DRender::QWaitFence::handleType
 
     Specifies the type of handle being used. Currently only OpenGL Fence ids
     are supported.
@@ -183,7 +183,7 @@ void QWaitFence::setHandleType(QWaitFence::HandleType type)
     Holds the underlying fence handle wrapped in a variant.
 */
 /*!
-    \property QWaitFence::handle
+    \property Qt3DRender::QWaitFence::handle
 
     Holds the underlying fence handle wrapped in a QVariant.
 */
-- 
cgit v1.2.3