aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2018-06-19 11:53:42 +0200
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2018-06-19 10:37:10 +0000
commita876bde97f3c7ca32769e53aca282a7b16429d04 (patch)
treeee3760a3443eb7a6d81db97118572cebf5d6caac /doc
parent0cda3a8e5a2f3e91e151a87e4b36b2972c4141d1 (diff)
Doc: Edit information about using Clang tools
- Add descriptions of "Build the project before analysis" and "Simultaneous processes" options. - Restructure the topic. Change-Id: I7fdeecad3383d1fc76dccce7dd53df8bf0cd9d64 Reviewed-by: Ivan Donchevskii <ivan.donchevskii@qt.io>
Diffstat (limited to 'doc')
-rw-r--r--doc/images/qtcreator-diagnostics-configuration.pngbin28934 -> 48327 bytes
-rw-r--r--doc/src/analyze/creator-clang-static-analyzer.qdoc46
2 files changed, 34 insertions, 12 deletions
diff --git a/doc/images/qtcreator-diagnostics-configuration.png b/doc/images/qtcreator-diagnostics-configuration.png
index 736a749c60..394a89e646 100644
--- a/doc/images/qtcreator-diagnostics-configuration.png
+++ b/doc/images/qtcreator-diagnostics-configuration.png
Binary files differ
diff --git a/doc/src/analyze/creator-clang-static-analyzer.qdoc b/doc/src/analyze/creator-clang-static-analyzer.qdoc
index d3b99b0efa..2c7b59b02a 100644
--- a/doc/src/analyze/creator-clang-static-analyzer.qdoc
+++ b/doc/src/analyze/creator-clang-static-analyzer.qdoc
@@ -68,14 +68,12 @@
\li Select \uicontrol Analyze > \uicontrol {Clang-Tidy and Clazy}.
- \image qtcreator-files-to-analyze.png
+ \image qtcreator-files-to-analyze.png "Analyzer Configuration dialog"
- \li In the \uicontrol {Diagnostic Configuration} group, select
- \uicontrol {Custom Settings}, and then select \uicontrol Manage to
- specify the Clang-Tidy and Clazy checks to perform.
-
- \li Select the new custom configuration in the list of configurations
- (1).
+ \li In the \uicontrol {Diagnostic Configuration} group, 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.
@@ -90,7 +88,10 @@
(\uicontrol Start) button to open the \uicontrol {Analyzer Configuration}
dialog.
- \image qtcreator-clang-tools.png
+ The found issues are displayed in the \uicontrol {Clang-Tidy and Clazy}
+ view:
+
+ \image qtcreator-clang-tools.png "Clang-Tidy and Clazy view"
Select the link in the \uicontrol Location column to move to the location
where the issue appears in the code editor.
@@ -106,14 +107,35 @@
\list
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Analyzer >
- \uicontrol {Clang Tools} > \uicontrol Manage.
+ \uicontrol {Clang Tools}.
+
+ \image qtcreator-clang-tools-options.png "Clang Tools options tab"
+
+ \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 {Simultaneous processes} field, select the number
+ of processes to run simultaneously to make the analysis faster on
+ multi-core processors.
+
+ \li In the \uicontrol {Diagnostic Configuration} group, select
+ \uicontrol Manage to create or edit a custom configuration.
+
+ \li Select \uicontrol Copy to create a custom Clang configuration.
+
+ \image qtcreator-diagnostics-configuration.png "Diagnostics Configuration dialog"
- \image qtcreator-clang-tools-options.png
+ \li In the \uicontrol {Diagnostic configuration name} field, give the
+ configuration a name, and then select \uicontrol OK.
\li In the \uicontrol {Clang-Tidy} tab, select the checks to
perform.
- \image qtcreator-clang-tidy.png
+ \image qtcreator-clang-tidy.png "Clang-Tidy tab"
\li To edit the selected check as plain text, select
\uicontrol {Edit Checks as String}.
@@ -121,7 +143,7 @@
\li In the \uicontrol Clazy tab, select the level of Clazy
checks to perform.
- \image qtcreator-clazy.png
+ \image qtcreator-clazy.png "Clazy tab"
\endlist