1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

QTestLib: improve documentation

Browse Source 
Add missing '\since' version numbers.

This commit amends cc6d984390dc937b9d8440b6ba7d4f578e22ac0d
and 0681a2dd5a8095baddb5905fb21a58ce19b958c5

Pick-to: 6.4
Change-Id: Ia10b991c996fb58f08a17e485c4dfcbfbe8eba0a
Reviewed-by: Marc Mutz <marc.mutz@qt.io>
Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
This commit is contained in:
Ivan Solovev 2022-06-07 08:51:47 +02:00
parent 5ddb13d0d4
commit 78c677376a
2 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/testlib/qtestcase.cpp
View File

@ -2950,6 +2950,7 @@ bool QTest::compare_helper(bool success, const char *failureMsg,
#endif // QT_DEPRECATED_SINCE(6, 4)
/*! \internal
\since 6.4
This function is called by various specializations of QTest::qCompare
to decide whether to report a failure and to produce verbose test output.
@ -2973,6 +2974,7 @@ bool QTest::compare_helper(bool success, const char *failureMsg,
}
/*! \internal
\since 6.4
This function is called by various specializations of QTest::qCompare
to decide whether to report a failure and to produce verbose test output.

12
src/testlib/qtestcase.qdoc
View File

@ -456,6 +456,7 @@
*/
/*! \macro QTRY_COMPARE_EQ_WITH_TIMEOUT(left, right, timeout)
\since 6.4
\relates QTest
This macro is similar to QCOMPARE_EQ(), but performs the comparison of the
@ -470,6 +471,7 @@
*/
/*! \macro QTRY_COMPARE_EQ(left, right)
\since 6.4
\relates QTest
Performs comparison of \a left and \a right values by invoking
@ -481,6 +483,7 @@
*/
/*! \macro QTRY_COMPARE_NE_WITH_TIMEOUT(left, right, timeout)
\since 6.4
\relates QTest
This macro is similar to QCOMPARE_NE(), but performs the comparison of the
@ -495,6 +498,7 @@
*/
/*! \macro QTRY_COMPARE_NE(left, right)
\since 6.4
\relates QTest
Performs comparison of \a left and \a right values by invoking
@ -506,6 +510,7 @@
*/
/*! \macro QTRY_COMPARE_LT_WITH_TIMEOUT(left, right, timeout)
\since 6.4
\relates QTest
This macro is similar to QCOMPARE_LT(), but performs the comparison of the
@ -520,6 +525,7 @@
*/
/*! \macro QTRY_COMPARE_LT(left, right)
\since 6.4
\relates QTest
Performs comparison of \a left and \a right values by invoking
@ -531,6 +537,7 @@
*/
/*! \macro QTRY_COMPARE_LE_WITH_TIMEOUT(left, right, timeout)
\since 6.4
\relates QTest
This macro is similar to QCOMPARE_LE(), but performs the comparison of the
@ -545,6 +552,7 @@
*/
/*! \macro QTRY_COMPARE_LE(left, right)
\since 6.4
\relates QTest
Performs comparison of \a left and \a right values by invoking
@ -556,6 +564,7 @@
*/
/*! \macro QTRY_COMPARE_GT_WITH_TIMEOUT(left, right, timeout)
\since 6.4
\relates QTest
This macro is similar to QCOMPARE_GT(), but performs the comparison of the
@ -570,6 +579,7 @@
*/
/*! \macro QTRY_COMPARE_GT(left, right)
\since 6.4
\relates QTest
Performs comparison of \a left and \a right values by invoking
@ -581,6 +591,7 @@
*/
/*! \macro QTRY_COMPARE_GE_WITH_TIMEOUT(left, right, timeout)
\since 6.4
\relates QTest
This macro is similar to QCOMPARE_GE(), but performs the comparison of the
@ -595,6 +606,7 @@
*/
/*! \macro QTRY_COMPARE_GE(left, right)
\since 6.4
\relates QTest
Performs comparison of \a left and \a right values by invoking