diff --git a/doc/qtcreator/images/qtcreator-clang-tidy.png b/doc/qtcreator/images/qtcreator-clang-tidy.png index 938a5d50284..4e1f234380e 100644 Binary files a/doc/qtcreator/images/qtcreator-clang-tidy.png and b/doc/qtcreator/images/qtcreator-clang-tidy.png differ diff --git a/doc/qtcreator/images/qtcreator-clang-tools-options-customized.png b/doc/qtcreator/images/qtcreator-clang-tools-options-customized.png new file mode 100644 index 00000000000..1941f1adc08 Binary files /dev/null and b/doc/qtcreator/images/qtcreator-clang-tools-options-customized.png differ diff --git a/doc/qtcreator/images/qtcreator-clang-tools.png b/doc/qtcreator/images/qtcreator-clang-tools.png index cd80438a8ae..5a541de42be 100644 Binary files a/doc/qtcreator/images/qtcreator-clang-tools.png and b/doc/qtcreator/images/qtcreator-clang-tools.png differ diff --git a/doc/qtcreator/images/qtcreator-clazy.png b/doc/qtcreator/images/qtcreator-clazy.png index 955357ed1e3..258bcb6ae62 100644 Binary files a/doc/qtcreator/images/qtcreator-clazy.png and b/doc/qtcreator/images/qtcreator-clazy.png differ diff --git a/doc/qtcreator/images/qtcreator-diagnostics-configuration.png b/doc/qtcreator/images/qtcreator-diagnostics-configuration.png index ca123f4df0a..4f68a780c45 100644 Binary files a/doc/qtcreator/images/qtcreator-diagnostics-configuration.png and b/doc/qtcreator/images/qtcreator-diagnostics-configuration.png differ diff --git a/doc/qtcreator/src/analyze/creator-clang-static-analyzer.qdoc b/doc/qtcreator/src/analyze/creator-clang-static-analyzer.qdoc index b098943269c..1ab345bb03e 100644 --- a/doc/qtcreator/src/analyze/creator-clang-static-analyzer.qdoc +++ b/doc/qtcreator/src/analyze/creator-clang-static-analyzer.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2019 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -67,6 +67,9 @@ \section1 Running Clang Tools + To run the Clang tools to analyze the currently open file, select + \uicontrol Tools > \uicontrol {C++} > \uicontrol {Analyze Current File}. + To run the Clang tools to analyze an open project: \list 1 @@ -96,9 +99,19 @@ the code editor. If a fixit exists for an issue, you can select the check box next to the - issue to schedule it for fixing. You can see the status of the issue by + issue to schedule it for fixing. Select the \uicontrol {Select Fixits} + check box to select all fixits. You can see the status of an issue by hovering the mouse pointer over the icon next to the check box. + To see more information about an issue that is marked with the + \inlineimage refactormarker.png + icon, hover the mouse pointer over the line. + + Select the \inlineimage settings.png + button to configure Clang diagnostics globally for Clang tools. + + \image qtcreator-clang-tools-options-customized.png "Clang Tools customized settings" + \section1 Configuring Clang Tools To configure Clang diagnostics globally for Clang tools: @@ -131,32 +144,28 @@ \li In the \uicontrol {Diagnostic configuration name} field, give the configuration a name, and then select \uicontrol OK. - \li In the \uicontrol Clang tab, select the + \li In the \uicontrol {Clang Warnings} tab, select the \uicontrol {Use diagnostic flags from the build system} check box to forward diagnostic flags, such as warning flags, from the build system to the Clang code model for displaying annotations in the code editor. - \li In the \uicontrol {Clang-Tidy} tab, select - \uicontrol {Select Checks} to select the checks to perform, - \uicontrol {Use .clang-tidy Config File} to read them from a - Clang-Tidy configuration file, or \uicontrol Disable to disable - them. + \li In the \uicontrol {Clang-Tidy Checks} tab, select + \uicontrol {Select Checks} to select the checks to perform. - \image qtcreator-clang-tidy.png "Clang-Tidy tab" + \image qtcreator-clang-tidy.png "Clang-Tidy Checks tab" - \li Select the \uicontrol {Web Page} link to view more - information about the available checkers in the + For more information about the available checkers, see \l{https://clang-analyzer.llvm.org/available_checks.html} {Clang Static Analyzer documentation}. \li To edit the selected check as plain text, select \uicontrol {Edit Checks as String}. - \li In the \uicontrol Clazy tab, select the level of Clazy + \li In the \uicontrol {Clazy Checks} tab, select the level of Clazy checks to perform. - \image qtcreator-clazy.png "Clazy tab" + \image qtcreator-clazy.png "Clazy Checks tab" \li In the \uicontrol {Topic Filter} field, select a topic to view only checks related to that area in the \uicontrol Checks field.