Doc: Add missing documentations of Window Type signals

Task-number: QTBUG-82705
Change-Id: I78a614c47a0f7d95b2a215d94e964c1202d89bcf
Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>

1 files changed, 84 insertions, 1 deletions

diff --git a/src/quick/items/qquickwindow.cpp b/src/quick/items/qquickwindow.cpp
index 0b12b13978..de7a28d66e 100644
--- a/src/quick/items/qquickwindow.cpp
+++ b/src/quick/items/qquickwindow.cpp
@@ -3869,6 +3869,13 @@ bool QQuickWindow::isSceneGraphInitialized() const
     This signal will be emitted from the scene graph rendering thread.
 */
 
+/*!
+    \qmlsignal QtQuick.Window::Window::frameSwapped()
+
+    This signal is emitted when a frame has been queued for presenting. With
+    vertical synchronization enabled the signal is emitted at most once per
+    vsync interval in a continuously animating scene.
+ */
 
 /*!
     \fn void QQuickWindow::sceneGraphInitialized()
@@ -3876,9 +3883,12 @@ bool QQuickWindow::isSceneGraphInitialized() const
     This signal is emitted when the scene graph has been initialized.
 
     This signal will be emitted from the scene graph rendering thread.
-
  */
 
+/*!
+    \qmlsignal QtQuick.Window::Window::sceneGraphInitialized()
+    \internal
+ */
 
 /*!
     \fn void QQuickWindow::sceneGraphInvalidated()
@@ -3898,6 +3908,11 @@ bool QQuickWindow::isSceneGraphInitialized() const
  */
 
 /*!
+    \qmlsignal QtQuick.Window::Window::sceneGraphInvalidated()
+    \internal
+ */
+
+/*!
     \fn void QQuickWindow::sceneGraphError(SceneGraphError error, const QString &message)
 
     This signal is emitted when an \a error occurred during scene graph initialization.
@@ -3913,6 +3928,19 @@ bool QQuickWindow::isSceneGraphInitialized() const
  */
 
 /*!
+    \qmlsignal QtQuick.Window::Window::sceneGraphError(SceneGraphError error, QString message)
+
+    This signal is emitted when an \a error occurred during scene graph initialization.
+
+    You can implement onSceneGraphError(error, message) to handle errors,
+    such as graphics context creation failures, in a custom way.
+    If no handler is connected to this signal, Quick will print the \a message,
+    or show a message box, and terminate the application.
+
+    \since 5.3
+ */
+
+/*!
     \class QQuickCloseEvent
     \internal
     \since 5.1
@@ -4257,6 +4285,11 @@ QQmlIncubationController *QQuickWindow::incubationController() const
 */
 
 /*!
+    \qmlsignal QtQuick.Window::Window::beforeSynchronizing()
+    \internal
+*/
+
+/*!
     \fn void QQuickWindow::afterSynchronizing()
 
     This signal is emitted after the scene graph is synchronized with the QML state.
@@ -4280,6 +4313,12 @@ QQmlIncubationController *QQuickWindow::incubationController() const
  */
 
 /*!
+    \qmlsignal QtQuick.Window::Window::afterSynchronizing()
+    \internal
+    \since 5.3
+ */
+
+/*!
     \fn void QQuickWindow::beforeRendering()
 
     This signal is emitted before the scene starts rendering.
@@ -4315,6 +4354,11 @@ QQmlIncubationController *QQuickWindow::incubationController() const
 */
 
 /*!
+    \qmlsignal QtQuick.Window::Window::beforeRendering()
+    \internal
+*/
+
+/*!
     \fn void QQuickWindow::afterRendering()
 
     This signal is emitted after the scene has completed rendering, before swapbuffers is called.
@@ -4348,6 +4392,11 @@ QQmlIncubationController *QQuickWindow::incubationController() const
  */
 
 /*!
+    \qmlsignal QtQuick.Window::Window::afterRendering()
+    \internal
+ */
+
+/*!
     \fn void QQuickWindow::beforeRenderPassRecording()
 
     This signal is emitted before the scenegraph starts recording commands for
@@ -4380,6 +4429,12 @@ QQmlIncubationController *QQuickWindow::incubationController() const
 */
 
 /*!
+    \qmlsignal QtQuick.Window::Window::beforeRenderPassRecording()
+    \internal
+    \since 5.14
+*/
+
+/*!
     \fn void QQuickWindow::afterRenderPassRecording()
 
     This signal is emitted after the scenegraph has recorded the commands for
@@ -4411,6 +4466,12 @@ QQmlIncubationController *QQuickWindow::incubationController() const
 */
 
 /*!
+    \qmlsignal QtQuick.Window::Window::afterRenderPassRecording()
+    \internal
+    \since 5.14
+*/
+
+/*!
     \fn void QQuickWindow::afterAnimating()
 
     This signal is emitted on the gui thread before requesting the render thread to
@@ -4425,6 +4486,17 @@ QQmlIncubationController *QQuickWindow::incubationController() const
  */
 
 /*!
+    \qmlsignal QtQuick.Window::Window::afterAnimating()
+
+    This signal is emitted on the gui thread before requesting the render thread to
+    perform the synchronization of the scene graph.
+
+    You can implement onAfterAnimating to do additional processing after each animation step.
+
+    \since 5.3
+ */
+
+/*!
     \fn void QQuickWindow::openglContextCreated(QOpenGLContext *context)
 
     This signal is emitted on the gui thread when the OpenGL \a context
@@ -4447,6 +4519,12 @@ QQmlIncubationController *QQuickWindow::incubationController() const
  */
 
 /*!
+    \qmlsignal QtQuick.Window::Window::openglContextCreated()
+    \internal
+    \since 5.3
+ */
+
+/*!
     \fn void QQuickWindow::sceneGraphAboutToStop()
 
     This signal is emitted on the render thread when the scene graph is
@@ -4469,6 +4547,11 @@ QQmlIncubationController *QQuickWindow::incubationController() const
     \since 5.3
  */
 
+/*!
+    \qmlsignal QtQuick.Window::Window::sceneGraphAboutToStop()
+    \internal
+    \since 5.3
+ */
 
 /*!
     Sets whether the scene graph rendering of QML should clear the color buffer