fix some QTest documentation
authorJeremy Katz <jeremy.katz@nokia.com>
Fri, 17 Aug 2012 12:37:07 +0000 (14:37 +0200)
committerQt by Nokia <qt-info@nokia.com>
Tue, 21 Aug 2012 04:48:46 +0000 (06:48 +0200)
* Use \b instead of \bold
* widnow -> window typo
* QTest::touchEvent's second parameter is QTouchDevice *, not
  QTouchEvent::DeviceType, and autoCommit defaults to true
* QSignalSpy::wait() isn't const

Change-Id: I75a91c1cd98b1c582cd654b2b72ad61e5c0e31d2
Reviewed-by: David Faure <faure@kde.org>
Reviewed-by: Jason McDonald <jason.mcdonald@nokia.com>
src/testlib/qsignalspy.qdoc
src/testlib/qtestcase.cpp

index e9e1f4d..1156a2f 100644 (file)
@@ -86,7 +86,7 @@
     \internal
 */
 
-/*! \fn QSignalSpy::wait(int timeout) const
+/*! \fn QSignalSpy::wait(int timeout)
 
     \since 5.0
 
index 73acf01..128ee73 100644 (file)
@@ -411,7 +411,7 @@ QT_BEGIN_NAMESPACE
    absolute paths to the source files are passed to the compiler. Otherwise, the
    absolute path of the source directory cannot be determined.
 
-   \bold {Note:} For tests that use the \l QTEST_APPLESS_MAIN() macro to generate a
+   \b {Note:} For tests that use the \l QTEST_APPLESS_MAIN() macro to generate a
    \c{main()} function, \c{QFINDTESTDATA} will not attempt to find test data
    relative to QCoreApplication::applicationDirPath().  In practice, this means that
    tests using \c{QTEST_APPLESS_MAIN()} will fail to find their test data
@@ -996,7 +996,7 @@ QT_BEGIN_NAMESPACE
     Adds a move event for touchpoint \a touchId at position \a pt to this sequence and returns
     a reference to this QTouchEventSequence.
 
-    The position \a pt is interpreted as relative to \a window. If \a widnow is the null pointer, then
+    The position \a pt is interpreted as relative to \a window. If \a window is the null pointer, then
     \a pt is interpreted as relative to the window provided when instantiating this QTouchEventSequence.
 
     Simulates that the user moved the finger identified by \a touchId.
@@ -1049,10 +1049,10 @@ QT_BEGIN_NAMESPACE
 */
 
 /*!
-    \fn QTouchEventSequence QTest::touchEvent(QWindow *window, QTouchEvent::DeviceType deviceType, bool autoCommit)
+    \fn QTouchEventSequence QTest::touchEvent(QWindow *window, QTouchDevice *device, bool autoCommit = true)
     \since 5.0
 
-    Creates and returns a QTouchEventSequence for the device \a deviceType to
+    Creates and returns a QTouchEventSequence for the \a device to
     simulate events for \a window.
 
     When adding touch events to the sequence, \a window will also be used to translate
@@ -1066,9 +1066,9 @@ QT_BEGIN_NAMESPACE
 */
 
 /*!
-    \fn QTouchEventSequence QTest::touchEvent(QWidget *widget, QTouchEvent::DeviceType deviceType, bool autoCommit)
+    \fn QTouchEventSequence QTest::touchEvent(QWidget *widget, QTouchDevice *device, bool autoCommit = true)
 
-    Creates and returns a QTouchEventSequence for the device \a deviceType to
+    Creates and returns a QTouchEventSequence for the \a device to
     simulate events for \a widget.
 
     When adding touch events to the sequence, \a widget will also be used to translate