Doc: Describe changes in Clang diagnostigs
Change-Id: I40dc02d3a4b18d352d0834033ab5ec67252f928d Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Before Width: | Height: | Size: 9.3 KiB After Width: | Height: | Size: 7.5 KiB |
After Width: | Height: | Size: 9.4 KiB |
Before Width: | Height: | Size: 9.7 KiB After Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 16 KiB |
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
@@ -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.
|
||||
|