diff options
| -rw-r--r-- | doc/config/qtcreator-project.qdocconf | 3 | ||||
| -rw-r--r-- | doc/images/qtcreator-clang-tools-options.png | bin | 5355 -> 8210 bytes | |||
| -rw-r--r-- | doc/images/qtcreator-clang-tools.png | bin | 16541 -> 9933 bytes | |||
| -rw-r--r-- | doc/images/qtcreator-files-to-analyze.png | bin | 9716 -> 5402 bytes | |||
| -rw-r--r-- | doc/src/analyze/creator-clang-static-analyzer.qdoc | 37 |
5 files changed, 15 insertions, 25 deletions
diff --git a/doc/config/qtcreator-project.qdocconf b/doc/config/qtcreator-project.qdocconf index 82daf9faad..b6710edb43 100644 --- a/doc/config/qtcreator-project.qdocconf +++ b/doc/config/qtcreator-project.qdocconf @@ -23,7 +23,8 @@ imagedirs = ../images \ ../../src/plugins/qmldesigner/qmlpreviewplugin/images \ ../../src/plugins/scxmleditor/common/images \ ../../src/plugins/texteditor/images \ - ../../src/plugins/valgrind/images + ../../src/plugins/valgrind/images \ + ../../src/plugins/welcome/images exampledirs = ../examples examples.fileextensions += *.qml *.svg diff --git a/doc/images/qtcreator-clang-tools-options.png b/doc/images/qtcreator-clang-tools-options.png Binary files differindex 6cf866f13f..3fce1e2dff 100644 --- a/doc/images/qtcreator-clang-tools-options.png +++ b/doc/images/qtcreator-clang-tools-options.png diff --git a/doc/images/qtcreator-clang-tools.png b/doc/images/qtcreator-clang-tools.png Binary files differindex 0ae985591c..cd80438a8a 100644 --- a/doc/images/qtcreator-clang-tools.png +++ b/doc/images/qtcreator-clang-tools.png diff --git a/doc/images/qtcreator-files-to-analyze.png b/doc/images/qtcreator-files-to-analyze.png Binary files differindex fcdf05c0db..add972f337 100644 --- a/doc/images/qtcreator-files-to-analyze.png +++ b/doc/images/qtcreator-files-to-analyze.png diff --git a/doc/src/analyze/creator-clang-static-analyzer.qdoc b/doc/src/analyze/creator-clang-static-analyzer.qdoc index c4468ef038..b378553495 100644 --- a/doc/src/analyze/creator-clang-static-analyzer.qdoc +++ b/doc/src/analyze/creator-clang-static-analyzer.qdoc @@ -60,6 +60,11 @@ Clang tools are delivered and installed with \QC, and therefore you do not need to set them up separately. + In addition to running the tools to collect diagnostics, you can select + \inlineimage open.png + to load diagnostics from \l{https://yaml.org/}{YAML} files that you exported + using the \c {-export fixes} option. + \section1 Running Clang Tools To run the Clang tools to analyze an open project: @@ -68,41 +73,25 @@ \li Select \uicontrol Analyze > \uicontrol {Clang-Tidy and Clazy}. - \image qtcreator-files-to-analyze.png "Analyzer Configuration dialog" - - \li In the \uicontrol General group, select \uicontrol {Custom Settings} - to modify the analyzer configuration. - - \li To build the project before running the Clang tools, select the - \uicontrol {Build the project before analysis} check box. The Clang - tools do not require the project to be built before analysis, but - they might display misleading warnings about files missing that are - generated during the build. For big projects, not building the - project might save some time. - - \li In the \uicontrol {Diagnostic configuration} field, select a Clang - configuration in the list of pre-defined configurations (1). For - more information about creating a custom configuration, see - \l {Configuring Clang Tools}. + \image qtcreator-files-to-analyze.png "Files to Analyze dialog" - \li In the \uicontrol {Files to Analyze} group, select the files to - apply the checks to. + \li Select the files to apply the checks to. \li Select \uicontrol Analyze to start the checks. \endlist - If you select \uicontrol Debug in the mode selector to open the - \uicontrol Debug mode and then select \uicontrol {Clang-Tidy and Clazy}, - you must select the \inlineimage qtcreator-analyze-start-button.png - (\uicontrol Start) button to open the \uicontrol {Analyzer Configuration} - dialog. - The found issues are displayed in the \uicontrol {Clang-Tidy and Clazy} view: \image qtcreator-clang-tools.png "Clang-Tidy and Clazy view" + \note If you select \uicontrol Debug in the mode selector to open the + \uicontrol Debug mode and then select \uicontrol {Clang-Tidy and Clazy}, + you must select the \inlineimage qtcreator-analyze-start-button.png + (\uicontrol Start) button to open the \uicontrol {Files to Analyze} + dialog. + Double-click an issue to move to the location where the issue appears in the code editor. |
