diff options
author | Mitch Curtis <[email protected]> | 2018-12-07 16:04:53 +0100 |
---|---|---|
committer | Mitch Curtis <[email protected]> | 2018-12-14 09:53:41 +0000 |
commit | ab26e8add8521422f54102beed214686e98592c3 (patch) | |
tree | 130c4023298488fa41c07d1a0696df8df591068f /src/qmltest/quicktest.cpp | |
parent | 0a92b02f1784a8934490633edcfed79fc685bfa2 (diff) |
Doc: Fix Qt Quick Test documentation
- Add qtquicktest-cppapi.qdoc for the C++ API landing page.
- Add qtquicktest.qdoc for the QQuickTest namespace.
- Add qtquicktest-qmltypes.qdoc for the QML types landing page.
- Add ../../imports/testlib to the sourcedirs variable so that
the QML files can be found.
- Add a "Reference" section to qtquicktest-index.qdoc that
has links to the QML and C++ pages.
- Add more targets so that we can reliably link to them
while keeping the nice short section names.
- Fix minor issues in existing documentation.
- Link to the QML API docs from the C++ API docs.
Change-Id: I5fc3c90105b095d9ea84c3f76e6c7ba0a47c2695
Reviewed-by: Topi Reiniƶ <[email protected]>
Reviewed-by: Paul Wicking <[email protected]>
Diffstat (limited to 'src/qmltest/quicktest.cpp')
-rw-r--r-- | src/qmltest/quicktest.cpp | 14 |
1 files changed, 5 insertions, 9 deletions
diff --git a/src/qmltest/quicktest.cpp b/src/qmltest/quicktest.cpp index 8803075284..1e25656048 100644 --- a/src/qmltest/quicktest.cpp +++ b/src/qmltest/quicktest.cpp @@ -77,8 +77,6 @@ QT_BEGIN_NAMESPACE /*! - \fn bool qIsPolishScheduled(const QQuickItem *item) - \relates QtQuickTest \since 5.13 Returns \c true if \l {QQuickItem::}{updatePolish()} has not been called @@ -103,6 +101,9 @@ QT_BEGIN_NAMESPACE makes it obvious why an item wasn't polished and allows tests to fail early under such circumstances. + The QML equivalent of this function is + \l {TestCase::}{isPolishScheduled()}. + \sa QQuickItem::polish(), QQuickItem::updatePolish() */ bool QQuickTest::qIsPolishScheduled(const QQuickItem *item) @@ -111,8 +112,6 @@ bool QQuickTest::qIsPolishScheduled(const QQuickItem *item) } /*! - \fn bool qWaitForItemPolished(const QQuickItem *item, int timeout = 5000) - \relates QtQuickTest \since 5.13 Waits for \a timeout milliseconds or until @@ -121,11 +120,8 @@ bool QQuickTest::qIsPolishScheduled(const QQuickItem *item) Returns \c true if \c updatePolish() was called on \a item within \a timeout milliseconds, otherwise returns \c false. - To use this function, add the following line to your test's \c .pro file: - - \code - QT += qmltest - \endcode + The QML equivalent of this function is + \l {TestCase::}{waitForItemPolished()}. \sa QQuickItem::polish(), QQuickItem::updatePolish(), QQuickTest::qIsPolishScheduled() |