forked from qt-creator/qt-creator
Doc: Update info about Clang tools
Change-Id: I86fecea5e5bc6d1b514cca4b8ad7a865cbf87c7e Reviewed-by: Nikolai Kosjar <nikolai.kosjar@qt.io>
This commit is contained in:
@@ -23,7 +23,8 @@ imagedirs = ../images \
|
|||||||
../../src/plugins/qmldesigner/qmlpreviewplugin/images \
|
../../src/plugins/qmldesigner/qmlpreviewplugin/images \
|
||||||
../../src/plugins/scxmleditor/common/images \
|
../../src/plugins/scxmleditor/common/images \
|
||||||
../../src/plugins/texteditor/images \
|
../../src/plugins/texteditor/images \
|
||||||
../../src/plugins/valgrind/images
|
../../src/plugins/valgrind/images \
|
||||||
|
../../src/plugins/welcome/images
|
||||||
|
|
||||||
exampledirs = ../examples
|
exampledirs = ../examples
|
||||||
examples.fileextensions += *.qml *.svg
|
examples.fileextensions += *.qml *.svg
|
||||||
|
Binary file not shown.
Before Width: | Height: | Size: 5.2 KiB After Width: | Height: | Size: 8.0 KiB |
Binary file not shown.
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 9.7 KiB |
Binary file not shown.
Before Width: | Height: | Size: 9.5 KiB After Width: | Height: | Size: 5.3 KiB |
@@ -60,6 +60,11 @@
|
|||||||
Clang tools are delivered and installed with \QC, and therefore you do not
|
Clang tools are delivered and installed with \QC, and therefore you do not
|
||||||
need to set them up separately.
|
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
|
\section1 Running Clang Tools
|
||||||
|
|
||||||
To run the Clang tools to analyze an open project:
|
To run the Clang tools to analyze an open project:
|
||||||
@@ -68,41 +73,25 @@
|
|||||||
|
|
||||||
\li Select \uicontrol Analyze > \uicontrol {Clang-Tidy and Clazy}.
|
\li Select \uicontrol Analyze > \uicontrol {Clang-Tidy and Clazy}.
|
||||||
|
|
||||||
\image qtcreator-files-to-analyze.png "Analyzer Configuration dialog"
|
\image qtcreator-files-to-analyze.png "Files to Analyze dialog"
|
||||||
|
|
||||||
\li In the \uicontrol General group, select \uicontrol {Custom Settings}
|
\li Select the files to apply the checks to.
|
||||||
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}.
|
|
||||||
|
|
||||||
\li In the \uicontrol {Files to Analyze} group, select the files to
|
|
||||||
apply the checks to.
|
|
||||||
|
|
||||||
\li Select \uicontrol Analyze to start the checks.
|
\li Select \uicontrol Analyze to start the checks.
|
||||||
|
|
||||||
\endlist
|
\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}
|
The found issues are displayed in the \uicontrol {Clang-Tidy and Clazy}
|
||||||
view:
|
view:
|
||||||
|
|
||||||
\image qtcreator-clang-tools.png "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
|
Double-click an issue to move to the location where the issue appears in
|
||||||
the code editor.
|
the code editor.
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user