diff options
Diffstat (limited to 'doc/qtcreator')
7 files changed, 106 insertions, 21 deletions
diff --git a/doc/qtcreator/config/qtcreator-project.qdocconf b/doc/qtcreator/config/qtcreator-project.qdocconf index 414ac30c9a..96559fbdf4 100644 --- a/doc/qtcreator/config/qtcreator-project.qdocconf +++ b/doc/qtcreator/config/qtcreator-project.qdocconf @@ -1,4 +1,4 @@ -project = "$IDE_DISPLAY_NAME" +project = qtcreator description = "$IDE_DISPLAY_NAME Manual" url = http://doc.qt.io/$IDE_ID diff --git a/doc/qtcreator/src/cmake/creator-projects-cmake.qdoc b/doc/qtcreator/src/cmake/creator-projects-cmake.qdoc index e5f61c7caf..3dd3a9197a 100644 --- a/doc/qtcreator/src/cmake/creator-projects-cmake.qdoc +++ b/doc/qtcreator/src/cmake/creator-projects-cmake.qdoc @@ -59,14 +59,8 @@ \section1 Adding CMake Tools - \QC supports CMake version 3.0, or later. For best results you should use - CMake version 3.7.2 with server-mode support, or later. Earlier versions - provide less information to the code model, which will then fail to resolve - includes and defines. - - For CMake version 3.14, or later, \QC supports the - \l {https://cmake.org/cmake/help/latest/manual/cmake-file-api.7.html} - {file-based API}. + \QC requires CMake's {https://cmake.org/cmake/help/latest/manual/cmake-file-api.7.html} + {file-based API}. Please make sure to use CMake version 3.14, or later. To specify paths to CMake executables: diff --git a/doc/qtcreator/src/editors/creator-code-refactoring.qdoc b/doc/qtcreator/src/editors/creator-code-refactoring.qdoc index cd1177b427..8e94c1622e 100644 --- a/doc/qtcreator/src/editors/creator-code-refactoring.qdoc +++ b/doc/qtcreator/src/editors/creator-code-refactoring.qdoc @@ -152,9 +152,14 @@ \section1 Column Editing - To apply a change to several rows in a column simultaneously, press - \key Alt, select the rows, and enter or remove text. The changes are made - simultaneously at the cursor position on all the selected rows. + To apply a change to several rows in a column simultaneously, hold + \key Alt, select the rows using the mouse, and enter or remove text. + The changes are made simultaneously at the cursor position on all the + selected rows. + + On Windows and Linux, you can also hold \key {Alt+Shift} and select + the rows using the arrow keys and the \key PageUp, \key PageDown, + \key Home, \key End keys. \section1 Applying Refactoring Actions diff --git a/doc/qtcreator/src/editors/creator-only/creator-code-pasting.qdoc b/doc/qtcreator/src/editors/creator-only/creator-code-pasting.qdoc index 5fbc28c832..852500d1b0 100644 --- a/doc/qtcreator/src/editors/creator-only/creator-code-pasting.qdoc +++ b/doc/qtcreator/src/editors/creator-only/creator-code-pasting.qdoc @@ -59,6 +59,9 @@ \li Select the \uicontrol {Display Output pane after sending a post} check box to display the URL in the \uicontrol {General Messages} output pane when you paste a post. + \li Select the \uicontrol {Make pasted content public by default} + check box to make the posted URL get listed on the service's website, + rather than only being available via the direct link. \endlist Select \uicontrol Fileshare to specify the path to a shared network drive. diff --git a/doc/qtcreator/src/howto/creator-only/creator-autotest.qdoc b/doc/qtcreator/src/howto/creator-only/creator-autotest.qdoc index 3c7703a866..78c7ffb680 100644 --- a/doc/qtcreator/src/howto/creator-only/creator-autotest.qdoc +++ b/doc/qtcreator/src/howto/creator-only/creator-autotest.qdoc @@ -31,11 +31,13 @@ \title Running Autotests \QC integrates the \l{Qt Test} framework, - \l{https://github.com/google/googletest}{Google C++ Testing Framework}, and + \l{https://github.com/google/googletest}{Google C++ Testing Framework}, \l{https://www.boost.org/doc/libs/1_70_0/libs/test/doc/html/index.html} - {Boost.Test} for unit testing applications and libraries. You can use \QC to - create, build, and run Qt tests, Qt Quick tests (QML-based Qt tests), Google - tests, and Boost tests for your projects. + {Boost.Test}, and \l{https://github.com/catchorg/Catch2} + {Catch2 test framework} for unit testing applications and libraries. + You can use \QC to create, build, and run Qt tests, + Qt Quick tests (QML-based Qt tests), Google tests, Boost tests, and + Catch2 tests for your projects. \image qtcreator-autotests.png @@ -175,6 +177,47 @@ \l{https://www.boost.org/doc/libs/1_70_0/libs/test/doc/html/index.html} {Boost.Test}. + \section2 Creating Catch2 Tests + + To build and run Catch2 tests, you either must have Catch2 libraries and + headers installed, or you can use the single include header file provided + by the Catch2 repository. + + If the Catch2 headers can be found by the used compiler and build system + automatically, you do not need to specify the include directory when + creating the test. + + To create a basic Catch2 test: + + \list 1 + \li Select \uicontrol File > \uicontrol {New File or Project} > + \uicontrol {Other Project} > \uicontrol {Auto Test Project} > + \uicontrol Choose to create a project with boilerplate code for a + Catch2 test. + \li In the \uicontrol {Project and Test Information} dialog, specify + settings for the project and test: + \list 1 + \li In the \uicontrol {Test framework} field, select + \uicontrol {Catch2}. + \li In the \uicontrol {Test case name} field, specify a name + to be used for the test case file. + \li Select the \uicontrol {Use Qt libraries} check box + to use a self defined main function and set up the project + to use Qt features. + \li In the \uicontrol {Catch2 include directory (optional)} field, + you may enter a path to the directory that contains the + Catch2 header files. + \li In the \uicontrol {Build system} field, select the build + system to use for building the project: qmake, CMake, or + Qbs. + \endlist + \endlist + + \QC creates the test in the specified project directory. + For more information about creating Catch2 tests, see + \l{https://github.com/catchorg/Catch2/blob/master/docs/Readme.md} + {Catch2}. + \section1 Setting Up the Google C++ Testing Framework To build and run Google tests, you must have the Google C++ Testing @@ -374,6 +417,38 @@ memory leaks. \endlist + \section2 Specifying Settings for Running Catch2 Tests + \list 1 + \li To specify settings for running Catch2 tests, select + \uicontrol Tools > \uicontrol Options > \uicontrol {Testing} > + \uicontrol {Catch Test}. + //! insert image here + \li Select the \uicontrol {Show success} check box to show succeeding + expressions as well. By default Catch2 will print only fails. + \li Select the \uicontrol {Break on failure while debugging} check box + to turn failures into debugger breakpoints. + \li Select the \uicontrol {Skip throwing assertions} check box to skip + any assertion that test for throwing an exception. + \li Select the \uicontrol {Visualize whitespace} check box to turn + whitespace into escape sequences. + \li Select the \uicontrol {Warn on empty tests} check box to get a + warning when a test case does not check any assertion. + \li Select the \uicontrol {Abort after} check box to abort the test + after the number of failures specified inside the spin box. + \li Select the \uicontrol {Benchmark samples} check box to specify + the number of samples to be collected while running benchmarks. + \li Select the \uicontrol {Benchmark resamples} check box to specify + the number of resamples to be used for the statistical + bootstrapping performed after the benchmarking. + \li Select the \uicontrol {Benchmark confidence interval} check box + to specify the confidence interval used for the statistical + bootstrapping. + \li Select the \uicontrol {Benchmark warmup time} check box to specify + the warmup time for each test before benchmarking start. + \li Select the \uicontrol {Disable analysis} check box to disable the + statistical analysis and bootstrapping. + \endlist + \section1 Viewing Test Output The test results are displayed in the \uicontrol {Test Results} output pane diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc index 2ff19db916..4622b2cc45 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc @@ -282,11 +282,9 @@ \list - \li C++ + \li C/C++ - C++ class, source, or header files that you can use to write the - application logic in both Qt Quick projects and - Qt widget based projects + C or C++ source and header files \li Qt diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-custom-wizards-json.qdocinc b/doc/qtcreator/src/projects/creator-only/creator-projects-custom-wizards-json.qdocinc index b53d8e9b92..3ef9ff43b9 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-custom-wizards-json.qdocinc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-custom-wizards-json.qdocinc @@ -785,7 +785,9 @@ "data": { "trText": "%{BaseCB}", - "trDisabledText": "%{BaseCB}" + "trDisabledText": "%{BaseCB}", + "historyId": "EditValues", + "restoreLastHistoryItem": false } }, \endcode @@ -808,6 +810,14 @@ \li \c isPassword is a boolean value that specifies that the line edit contains a password, which will be masked. + \li \c historyId is a key that specifies the name for a list of items + for the history completer. + + \li \c restoreLastHistoryItem is a boolean that specifies that the + last history item is automatically set as the default text in + the line edit. This key can only be set to true if \c historyId + is also set. + \endlist \section2 Path Chooser |