Changeset 846 for trunk/doc/src/development/qtestlib.qdoc

Timestamp:

May 5, 2011, 5:36:53 AM (14 years ago)

Author:

Dmitry A. Kuminov

Message:

trunk: Merged in qt 4.7.2 sources from branches/vendor/nokia/qt.

Location:

trunk

Files:

• . (modified) (1 prop)
• doc/src/development/qtestlib.qdoc (modified) (17 diffs)

trunk/doc/src/development/qtestlib.qdoc

@@ -1 +1 @@
 /****************************************************************************
 **
-** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
+** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
 ** All rights reserved.
 ** Contact: Nokia Corporation (qt-info@nokia.com)
@@ -7 +7 @@
 ** This file is part of the documentation of the Qt Toolkit.
 **
-** $QT_BEGIN_LICENSE:LGPL$
+** $QT_BEGIN_LICENSE:FDL$
 ** Commercial Usage
 ** Licensees holding valid Qt Commercial licenses may use this file in
 ** accordance with the Qt Commercial License Agreement provided with the
-** Software or, alternatively, in accordance with the terms contained in
-** a written agreement between you and Nokia.
+** Software or, alternatively, in accordance with the terms contained in a
+** written agreement between you and Nokia.
 **
-** GNU Lesser General Public License Usage
-** Alternatively, this file may be used under the terms of the GNU Lesser
-** General Public License version 2.1 as published by the Free Software
-** Foundation and appearing in the file LICENSE.LGPL included in the
-** packaging of this file.  Please review the following information to
-** ensure the GNU Lesser General Public License version 2.1 requirements
-** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
-**
-** In addition, as a special exception, Nokia gives you certain additional
-** rights.  These rights are described in the Nokia Qt LGPL Exception
-** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
-**
-** GNU General Public License Usage
-** Alternatively, this file may be used under the terms of the GNU
-** General Public License version 3.0 as published by the Free Software
-** Foundation and appearing in the file LICENSE.GPL included in the
-** packaging of this file.  Please review the following information to
-** ensure the GNU General Public License version 3.0 requirements will be
-** met: http://www.gnu.org/copyleft/gpl.html.
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of this
+** file.
 **
 ** If you have questions regarding the use of this file, please contact
@@ -46 +32 @@
 
     \ingroup frameworks-technologies
+    \ingroup qt-basic-concepts
+
     \keyword qtestlib
 
@@ -53 +41 @@
     well as extensions for testing graphical user interfaces.
 
-    Table of contents:
-
-    \tableofcontents
-
     \section1 QTestLib Features
 
@@ -101 +85 @@
     \endtable
 
-    Note: For higher-level GUI and application testing needs, please
-    see the \l{Third-Party Tools}{Qt testing products provided by
-    Nokia partners}.
+    \note For higher-level GUI and application testing needs, please
+    see the \l{Partner Directory} for Qt testing products provided by
+    Nokia partners.
 
 
@@ -230 +214 @@
 
     \section2 Creating a Benchmark
-    
-    To create a benchmark, follow the instructions for crating a test and then add a
+
+    To create a benchmark, follow the instructions for creating a test and then add a
     QBENCHMARK macro to the test function that you want to benchmark.
-    
+
     \snippet doc/src/snippets/code/doc_src_qtestlib.qdoc 12
-    
-    The code insde the QBENCHMARK macro will be measured, and possibly also repeated
+
+    The code inside the QBENCHMARK macro will be measured, and possibly also repeated
     several times in order to get an accurate measurement. This depends on the selected
     measurement back-end. Several back-ends are available. They can be selected on the
     command line:
-    
+
     \target testlib-benchmarking-measurement
 
@@ -260 +244 @@
          \o All platforms
     \endtable
-    
+
     In short, walltime is always available but requires many repetitions to
-    get a useful result. 
-    Tick counters are usually available and can provide 
-    results with fewer repetitions, but can be susceptible to CPU frequency 
-    scaling issues. 
+    get a useful result.
+    Tick counters are usually available and can provide
+    results with fewer repetitions, but can be susceptible to CPU frequency
+    scaling issues.
     Valgrind provides exact results, but does not take
     I/O waits into account, and is only available on a limited number of
@@ -272 +256 @@
     that were received by the event loop before they are sent to their corresponding
     targets (this might include non-Qt events).
-       
+
     \note Depending on the device configuration, Tick counters on the
      Windows CE platform may not be as fine-grained, compared to other platforms.
@@ -281 +265 @@
 
     \section1 Using QTestLib remotely on Windows CE
-    \c cetest is a convenience application which helps the user to launch an 
+    \c cetest is a convenience application which helps the user to launch an
     application remotely on a Windows CE device or emulator.
 
@@ -337 +321 @@
     cetest and QtRemote successfully.
 
-    Prior to \l{Installing Qt on Windows CE}{installation} of Qt, you need to set your
+    Prior to \l{Installing Qt for Windows CE}{installation} of Qt, you need to set your
     \c INCLUDE and \c LIB environment variables properly.
 
@@ -351 +335 @@
     The CPU tick counters used for benchmarking is licensed under the following
     license: (from src/testlib/3rdparty/cycle.h)
-                    
+
     \legalese
     Copyright (c) 2003, 2006 Matteo Frigo\br
@@ -382 +366 @@
     \contentspage QTestLib Manual
     \nextpage {Chapter 1: Writing a Unit Test}{Chapter 1}
+    \ingroup best-practices
 
     \title QTestLib Tutorial
 
     This tutorial gives a short introduction to how to use some of the
-    features of the QTestLib framework. It is divided into four
+    features of the QTestLib framework. It is divided into five
     chapters:
 
@@ -583 +568 @@
     \example qtestlib/tutorial3
 
-    \previouspage {Chapter 2 Data Driven Testing}{Chapter 2}
+    \previouspage {Chapter 2: Data Driven Testing}{Chapter 2}
     \contentspage {QTestLib Tutorial}{Contents}
     \nextpage {Chapter 4: Replaying GUI Events}{Chapter 4}
@@ -733 +718 @@
     \section1 Writing a Benchmark
     To create a benchmark we extend a test function with a QBENCHMARK macro.
-    A benchmark test function will then typically consist of setup code and 
+    A benchmark test function will then typically consist of setup code and
     a QBENCHMARK macro that contains the code to be measured. This test
     function benchmarks QString::localeAwareCompare().
@@ -739 +724 @@
     \snippet examples/qtestlib/tutorial5/benchmarking.cpp 0
 
-    Setup can be done at the beginning of the function, the clock is not 
+    Setup can be done at the beginning of the function, the clock is not
     running at this point. The code inside the QBENCHMARK macro will be
-    measured, and possibly repeated several times in order to  get an 
+    measured, and possibly repeated several times in order to  get an
     accurate measurement.
 
@@ -749 +734 @@
     \section1 Data Functions
 
-    Data functions are useful for creating benchmarks that compare 
+    Data functions are useful for creating benchmarks that compare
     multiple data inputs, for example locale aware compare against standard
     compare.
@@ -759 +744 @@
     \snippet examples/qtestlib/tutorial5/benchmarking.cpp 2
 
-    The "if(useLocaleCompare)" switch is placed outside the QBENCHMARK 
+    The "if(useLocaleCompare)" switch is placed outside the QBENCHMARK
     macro to avoid measuring its overhead. Each benchmark test function
-    can have one active QBENCHMARK macro. 
+    can have one active QBENCHMARK macro.
 
     \section1 External Tools
 
     Tools for handling and visualizing test data are available as part of
-    the \l{qtestlib-tools} project on the Qt Labs Web site. These include
-    a tool for comparing performance data obtained from test runs and a
-    utility to generate Web-based graphs of performance data.
-
-    See the \l{qtestlib-tools Announcement} for more information on these
-    tools and a simple graphing example.
+    the \l {qtestlib-tools} project in the \l{Qt Labs} web site.
+        These include a tool for comparing performance data obtained from test
+        runs and a utility to generate Web-based graphs of performance data.
+
+    See the \l{qtestlib-tools Announcement}{qtestlib-tools announcement}
+    for more information on these tools and a simple graphing example.
 
 */