Skip to content

Commit

Permalink
Doc: Revise Qt Test Module landing page
Browse files Browse the repository at this point in the history
Most of the module landing pages now follow a certain content structure.
In this case, the reference section should be placed before the
licenses and attributions section. Also, to make the wording consistent
across all module landing pages, use the globally available word
snippets.

Pick-to: 6.4
Change-Id: I2b2164eb1b8a0eb91db0f1efea8390956d54b29e
Reviewed-by: Kai Koehne <[email protected]>
  • Loading branch information
andreaseliasson committed Jun 27, 2022
1 parent c0509ef commit a6df765
Showing 1 changed file with 24 additions and 21 deletions.
45 changes: 24 additions & 21 deletions src/testlib/doc/src/qttest-index.qdoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2020 The Qt Company Ltd.
// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page qttest-index.html
Expand All @@ -16,13 +16,17 @@
to work with the Qt version it was developed against. However, source
compatibility is guaranteed.

\include module-use.qdocinc using qt module
\snippet snippets/CMakeLists.txt cmake_use
\section1 Using the Module

See also the \l {Build with CMake} overview.
\include {module-use.qdocinc} {using the c++ api}

\include module-use.qdocinc building with qmake
\snippet snippets/code/code.pro qmake_use
\section2 Building with CMake

\include {module-use.qdocinc} {building with cmake} {Test}

\section2 Building with qmake

\include {module-use.qdocinc} {building_with_qmake} {testlib}

\section1 Articles and Guides

Expand All @@ -32,6 +36,19 @@
\li \l{Qt Test Tutorial}
\endlist

\section1 Reference

\list
\li \l{Qt Test C++ Classes}
\endlist

The \l {Qt Quick Test} module enables unit testing of Qt Quick applications.

\list
\li \l{Qt Quick Test QML Types}
\li \l{Qt Quick Test C++ API}
\endlist

\section1 Module Evolution
\l{Changes to Qt Test} lists important changes in the module API
and functionality that were done for the Qt 6 series of Qt.
Expand All @@ -45,21 +62,7 @@
See \l{Qt Licensing} for further details.

Furthermore, Qt Test in Qt \QtVersion may contain third party
modules under following permissive licenses:
modules under the following permissive licenses:

\generatelist{groupsbymodule attributions-qttestlib}

\section1 Reference

\list
\li \l{Qt Test C++ Classes}
\endlist

The \l {Qt Quick Test} module enables unit testing Qt Quick applications.

\list
\li \l{Qt Quick Test QML Types}
\li \l{Qt Quick Test C++ API}
\endlist

*/

0 comments on commit a6df765

Please sign in to comment.