From 3b03150aa2af76b13424c988c6c7892d19cce6c5 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Wed, 12 Dec 2018 12:36:39 +0100 Subject: Doc: Restore documentation for QTest functions in other modules Qt Test library sources specific to Core, GUI and Widgets modules were moved around in commit 88867e39b. The new source locations must be referenced in Qt Test documentation configuration. The same sources are excluded in their original doc projects, and the related snippet file is moved over to qttestlib. The commit also fixes the remaining documentation issues for Qt Test. Change-Id: Ibe011aa83639e574d647f12bc9e53e618781bce6 Reviewed-by: Martin Smith --- src/widgets/kernel/qtestsupport_widgets.cpp | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) (limited to 'src/widgets/kernel/qtestsupport_widgets.cpp') diff --git a/src/widgets/kernel/qtestsupport_widgets.cpp b/src/widgets/kernel/qtestsupport_widgets.cpp index b227e6ff5d..0056bebdc6 100644 --- a/src/widgets/kernel/qtestsupport_widgets.cpp +++ b/src/widgets/kernel/qtestsupport_widgets.cpp @@ -46,15 +46,14 @@ QT_BEGIN_NAMESPACE -/*! \fn bool qWaitForWindowActive(QWidget *widget, int timeout) - \relates QTest +/*! \since 5.0 Waits for \a timeout milliseconds or until the \a widget's window is active. Returns \c true if \c widget's window is active within \a timeout milliseconds, otherwise returns \c false. - \sa QTest::qWaitForWindowExposed(), QWidget::isActiveWindow() + \sa qWaitForWindowExposed(), QWidget::isActiveWindow() */ Q_WIDGETS_EXPORT Q_REQUIRED_RESULT bool QTest::qWaitForWindowActive(QWidget *widget, int timeout) { @@ -63,8 +62,7 @@ Q_WIDGETS_EXPORT Q_REQUIRED_RESULT bool QTest::qWaitForWindowActive(QWidget *wid return false; } -/*! \fn bool qWaitForWindowExposed(QWidget *widget, int timeout) - \relates QTest +/*! \since 5.0 Waits for \a timeout milliseconds or until the \a widget's window is exposed. @@ -80,7 +78,7 @@ Q_WIDGETS_EXPORT Q_REQUIRED_RESULT bool QTest::qWaitForWindowActive(QWidget *wid A specific configuration where this happens is when using QGLWidget as a viewport widget on macOS: The viewport widget gets the expose event, not the parent widget. - \sa QTest::qWaitForWindowActive() + \sa qWaitForWindowActive() */ Q_WIDGETS_EXPORT Q_REQUIRED_RESULT bool QTest::qWaitForWindowExposed(QWidget *widget, int timeout) { @@ -89,11 +87,12 @@ Q_WIDGETS_EXPORT Q_REQUIRED_RESULT bool QTest::qWaitForWindowExposed(QWidget *wi return false; } -/*! \fn bool qWaitForWindowShown(QWidget *widget, int timeout) - \relates QTest +/*! \fn bool QTest::qWaitForWindowShown(QWidget *widget, int timeout) \since 5.0 \deprecated + Use qWaitForWindowExposed() instead. + Waits for \a timeout milliseconds or until the \a widget's window is exposed. Returns \c true if \c widget's window is exposed within \a timeout milliseconds, otherwise returns \c false. @@ -107,7 +106,7 @@ Q_WIDGETS_EXPORT Q_REQUIRED_RESULT bool QTest::qWaitForWindowExposed(QWidget *wi QTest::qWaitForWindowShown(&widget); \endcode - \sa QTest::qWaitForWindowActive(), QTest::qWaitForWindowExposed() + \sa qWaitForWindowActive(), qWaitForWindowExposed() */ QT_END_NAMESPACE -- cgit v1.2.3