Doc: Update info about autotests

- Split the topic up into how-to and reference topics
- Add and remove descriptions of preferences
- Move general information to the overview
- Describe qdt locator filter

Task-number: QTCREATORBUG-30209
Task-number: QTCREATORBUG-29361
Change-Id: Idb29eebaeb2f77326ebbb5e6b5654c135473f329
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
This commit is contained in:
Leena Miettinen
2024-03-01 14:58:22 +01:00
parent 36c7d971c3
commit add834577b
21 changed files with 623 additions and 423 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 9.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.5 KiB

After

Width:  |  Height:  |  Size: 4.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.9 KiB

File diff suppressed because it is too large Load Diff

View File

@@ -93,6 +93,18 @@
\generatelist creator-how-to-get-help
\section1 Test
\QC supports both \e {code based tests} and \e {build system based tests}.
Code based testing offers special handling for particular testing
frameworks that strongly ties to the underlying code models or
specialized parsers. Build system based testing is independent from any
testing frameworks. It retrieves information directly from the underlying
build system and uses it or even the build system as such to execute the
respective tests.
\generatelist creator-how-to-test
\section1 Use \QC
\generatelist creator-how-to-use

View File

@@ -27,7 +27,7 @@
\image qt-app-dev-flow.webp {Application development life-cycle}
\caption Application development life-cycle
\section1 Projects
\section1 Managing Projects
First, you need a \e project. \QC relies on a separate build system, such as
CMake, qmake, or Qbs for building the project. From the build system, \QC
@@ -63,12 +63,12 @@
For more information, see \l{Manage Projects}{How To: Manage Projects}.
\section1 User Interfaces
\section1 Designing User Interfaces
\image heartgame-start.webp {Heart Rate Game}
To create intuitive, modern-looking, fluid user interfaces, use \l{Qt Quick}
and \l{Qt Design Studio Manual}{\QDS}:
To create intuitive, modern-looking, fluid user interfaces (UI), use
\l{Qt Quick} and \l{Qt Design Studio Manual}{\QDS}:
\list
\li \l {\QMLD}
@@ -101,7 +101,7 @@
For more information, see \l{Design UIs}{How To: Design UIs} and
\l{UI Design}.
\section1 Code
\section1 Editing Code
Writing, editing, and navigating in source code are core tasks in application
development. Therefore, the code editor is one of the key components of \QC.
@@ -116,13 +116,13 @@
such as Python, for which a \e {language server} is available that provides
information about the code to IDEs.
\section2 Find
\section2 Finding
Use the incremental and advanced search to search in currently open projects
or files on the file system or use the locator to browse through projects,
files, classes, functions, documentation, and file systems.
\section2 Refactor
\section2 Refactoring Code
\e {Code refactoring} is the process of improving and simplifying code
without modifying the existing functionality of an application. Find
@@ -137,7 +137,7 @@
\li Simplify code structure
\endlist
\section2 Configure the Editor
\section2 Configuring the Text Editor
Configure the text editor to suit your specific needs. Change the fonts,
colors, highlighting, and indentation.
@@ -147,7 +147,7 @@
For more information, see \l{Edit Code}{How To: Edit Code} and \l{Editors}.
\section1 Build, Deploy, and Run
\section1 Building, Deploying, and Running Applications
Run and deploy Qt applications that you build for different target
platforms or with different compilers, debuggers, or Qt versions.
@@ -182,7 +182,7 @@
For more information, see \l{Connecting Devices} and \l{Deploying to Devices}.
\section2 Preview QML
\section2 Previewing QML
Use the QML live preview to preview a QML file or an entire Qt Quick
application on the desktop, as well as on Android and embedded Linux
@@ -191,7 +191,7 @@
For more information, see \l{Validating with Target Hardware}.
\section1 Debug
\section1 Debugging Applications
A debugger lets you see what happens \e inside an application while it runs
or when it crashes. A debugger can do the following to help you find errors
@@ -214,7 +214,7 @@
For more information, see \l{Debugging}.
\section1 Analyze
\section1 Analyzing Source Code
Devices have limited memory and CPU power, so you should use them carefully.
\QC integrates code analysis tools for detecting memory leaks, profiling
@@ -227,17 +227,42 @@
For more information, see \l{Analyzing Code}.
\section1 Autotest
\section1 Running Tests
Create, build and run Qt tests, Qt Quick tests, Google tests, and Boost tests
to unit test applications and libraries.
\QC supports both \e {code based tests} and \e {build system based tests}.
Code based testing offers special handling for particular testing
frameworks that strongly ties to the underlying code models or
specialized parsers. Build system based testing is independent from any
testing frameworks. It retrieves information directly from the underlying
build system and uses it or even the build system as such to execute the
respective tests.
\QC integrates the following testing frameworks for unit testing
applications and libraries:
\list
\li \l{https://www.boost.org/doc/libs/1_81_0/libs/test/doc/html/index.html}
{Boost.Test}
\li \l{https://github.com/catchorg/Catch2}{Catch2 test framework}
\li \l{https://github.com/google/googletest}{Google C++ Testing Framework}
\li \l{Qt Quick Test} framework
\li \l{Qt Test} framework
\endlist
In addition, \QC offers build system based support for
\l{https://cmake.org/cmake/help/latest/manual/ctest.1.html}{CTest}.
You can use \QC to create, build, and run code based tests for your
projects.
\image qtcreator-autotests.png
Map AUTs (Application Under Test) to \QC and run Squish test suites
and cases from it.
For more information, see \l{Running Autotests} and \l{Using Squish}.
For more information, see \l{Test}{How To: Test} and \l{Using Squish}.
\section1 Publish
\section1 Publishing Applications
Create installation packages for mobile devices that you publish to
application stores and other channels. You must make sure that the

View File

@@ -37,7 +37,7 @@
\section1 Preferences
Set prefecerences that apply globally to all projects.
Set preferences that apply globally to all projects.
\annotatedlist creator-reference-preferences

View File

@@ -12,7 +12,7 @@
\page creator-testing.html
\nextpage creator-debugging.html
\title Testing
\title Debugging and Analyzing
\image front-testing.png
@@ -35,11 +35,6 @@
from \QC. However, the QML Profiler is installed as part of \QC
for profiling Qt Quick applications.
\li \l{Running Autotests}
Create, build and run Qt tests, Qt Quick tests, Google
tests, and Boost tests using \QC.
\li \l{Using Squish}
Map AUTs to \QC and run Squish test suites and cases from it.

View File

@@ -74,8 +74,8 @@
\li Empty Nim source and script files.
\endtable
\sa {Add Files}{How To: Add Files}, {Create UML-style models},
{Use project wizards}
\sa {Add Files}{How To: Add Files}, {Add tests to existing test projects},
{Create UML-style models}, {Use project wizards}
*/
/*!

View File

@@ -168,8 +168,8 @@
\uicontrol Impl there.
\sa {Assign keyboard shortcuts}, {Activate kits for a project},
{Create files}, {Create Projects}{How To: Create Projects},
{Creating Projects}
{Create files}, {Test}{How To: Test},
{Create Projects}{How To: Create Projects}, {Creating Projects}
*/
/*!

View File

@@ -49,7 +49,7 @@
\section1 Select run targets
If your project has several run targets defined, such as
\l{Running Autotests}{tests}, you can select them in the kit selector.
\l{Build and run tests}{tests}, you can select them in the kit selector.
\image qtcreator-kit-selector-run-targets.png {Run targets in the kit selector}

View File

@@ -68,7 +68,7 @@
\li \l{Building Applications for the Web}
\endlist
\endlist
\li \l{Testing}
\li \l{Debugging and Analyzing}
\list
\li \l{Debugging}
\list
@@ -112,7 +112,6 @@
\li \l{Analyzing Code with Cppcheck}
\li \l{Visualizing Chrome Trace Events}
\endlist
\li \l{Running Autotests}
\li \l{Using Squish}
\endlist
\li \l{How To}
@@ -157,6 +156,8 @@
\endlist
\li Read Documentation
\generatelist creator-how-to-get-help
\li Test
\generatelist creator-how-to-test
\li Use \QC
\generatelist creator-how-to-use
\li Use the UI

View File

@@ -64,11 +64,10 @@
\li \inlineimage front-help.png
\li \inlineimage front-advanced.png
\row
\li \b {\l{Testing}}
\li \b {\l{Debugging and Analyzing}}
\list
\li \l{Debugging}
\li \l{Analyzing Code}
\li \l{Running Autotests}
\li \l{Using Squish}
\endlist
\li \b {\l{How To}}
@@ -79,6 +78,10 @@
\li \l{Design UIs}
\li \l{Edit Code}
\li \l{Manage Projects}
\li \l{Read Documentation}
\li \l{Test}
\li \l{Use \QC}
\li \l{Use the UI}
\li \l{How To}{See More...}
\endlist
\li \b {\l{Reference}}