summaryrefslogtreecommitdiffstats
path: root/src/testlib/doc/src/qttest-index.qdoc
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@digia.com>2012-10-26 10:11:36 +0200
committerLeena Miettinen <riitta-leena.miettinen@digia.com>2012-11-02 10:35:30 +0100
commit8f1687c572ea661a7b91b0aa675796145513c275 (patch)
treea81c2a552487ff72bc1523f4379007ad437100f7 /src/testlib/doc/src/qttest-index.qdoc
parent7c50e0b8df63048081108045533a852526c63218 (diff)
Doc: add landing page for Qt Test
Replace "QTestLib" with "Qt Test". Some style and language edits. Remove some empty headings. Change-Id: I568b4bbde981c3ef1899c830931892c16b66b4e2 Reviewed-by: Lars Knoll <lars.knoll@digia.com> Reviewed-by: Jason McDonald <macadder1@gmail.com>
Diffstat (limited to 'src/testlib/doc/src/qttest-index.qdoc')
-rw-r--r--src/testlib/doc/src/qttest-index.qdoc62
1 files changed, 62 insertions, 0 deletions
diff --git a/src/testlib/doc/src/qttest-index.qdoc b/src/testlib/doc/src/qttest-index.qdoc
new file mode 100644
index 0000000000..f536529420
--- /dev/null
+++ b/src/testlib/doc/src/qttest-index.qdoc
@@ -0,0 +1,62 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia. For licensing terms and
+** conditions see http://qt.digia.com/licensing. For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** 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. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+/*!
+ \page qttest-index.html
+ \title Qt Test
+ \brief Provides classes for unit testing Qt applications and libraries.
+
+ Qt Test provides classes for unit testing Qt applications and libraries.
+ All public methods are in the \l QTest namespace. In addition, the
+ \l QSignalSpy class provides easy introspection for Qt's signals and slots.
+
+ \section1 Getting Started
+
+ To enable Qt Test in a project, add this directive into the C++ files:
+
+ \snippet code/doc_src_qttest.cpp 0
+
+ To link against Qt Test, add this line to the project file:
+
+ \snippet code/doc_src_qttest.pro 1
+
+ \section1 Articles and Guides
+
+ \list
+ \li \l{Qt Test Overview}
+ \li \l{Qt Test Tutorial}
+ \endlist
+
+ \section1 Reference
+
+ These are links to the API reference materials.
+
+ \list
+ \li \l{Qt Test C++ Classes}{C++ Classes}
+ \endlist
+
+*/
+