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

Update QSKIP documentation.

Browse Source 
Task-number: QTBUG-21851, QTBUG-21652

Change-Id: I3d4cf8e11756b92fe9d97f01a02c61cbf2df1556
Reviewed-by: Rohan McGovern <rohan.mcgovern@nokia.com>
This commit is contained in:
Jason McDonald 2011-10-20 12:12:43 +10:00 committed by Qt by Nokia
parent 27f9f136f7
commit d766ae0457
1 changed files with 17 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/testlib/qtestcase.cpp
View File

@ -271,17 +271,25 @@ QT_BEGIN_NAMESPACE
\relates QTest \relates QTest
The QSKIP() macro stops execution of the test without adding a failure to the If called from a test function, the QSKIP() macro stops execution of the test
test log. You can use it to skip tests that wouldn't make sense in the current without adding a failure to the test log. You can use it to skip tests that
configuration. The text \a description is appended to the test log and should wouldn't make sense in the current configuration. The text \a description is
contain an explanation of why the test couldn't be executed. appended to the test log and should contain an explanation of why the test
couldn't be executed.
If the test is data-driven, each call to QSKIP() will skip only the current row, If the test is data-driven, each call to QSKIP() will skip only the current
so an unconditional call to QSKIP will produce one skip message in the test log row of test data, so an unconditional call to QSKIP will produce one skip
for each row of test data. message in the test log for each row of test data.
\bold {Note:} This macro can only be used in a test function that is invoked If called from an _data function, the QSKIP() macro will stop execution of
by the test framework. the _data function and will prevent execution of the associated test
function.
If called from initTestCase() or initTestCase_data(), the QSKIP() macro will
skip all test and _data functions.
\bold {Note:} This macro can only be used in a test function or _data
function that is invoked by the test framework.
Example: Example:
\snippet doc/src/snippets/code/src_qtestlib_qtestcase.cpp 8 \snippet doc/src/snippets/code/src_qtestlib_qtestcase.cpp 8