diff options
| author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2018-01-26 10:36:19 +0100 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2018-01-26 14:37:39 +0000 |
| commit | 6deec195f1b00ba941c12eee9ea1024d3ddabc54 (patch) | |
| tree | 43bd2080f238deb644de748aea3c04661e024d85 /doc | |
| parent | 9b495853c663c3efac4b8c3c440b4a9ab70f6999 (diff) | |
Doc: Describe selecting Clang-Tidy and Clazy checks
Also mention support for C++17 and renaming of local symbols.
Change-Id: I7bb72bd8741e7ddd3d45e23029696c09a654a3f6
Reviewed-by: Ivan Donchevskii <ivan.donchevskii@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/images/qtcreator-clang-code-model-options.png | bin | 58844 -> 71706 bytes | |||
| -rw-r--r-- | doc/src/editors/creator-clang-codemodel.qdoc | 23 |
2 files changed, 21 insertions, 2 deletions
diff --git a/doc/images/qtcreator-clang-code-model-options.png b/doc/images/qtcreator-clang-code-model-options.png Binary files differindex c48856a201..1c35af1fb0 100644 --- a/doc/images/qtcreator-clang-code-model-options.png +++ b/doc/images/qtcreator-clang-code-model-options.png diff --git a/doc/src/editors/creator-clang-codemodel.qdoc b/doc/src/editors/creator-clang-codemodel.qdoc index c3e52e6a9b..673159fd90 100644 --- a/doc/src/editors/creator-clang-codemodel.qdoc +++ b/doc/src/editors/creator-clang-codemodel.qdoc @@ -75,8 +75,8 @@ useful if the code contains typos, for example. Clang keeps up with the development of the C++ language. At the time of this - writing, it supports C++98/03, C++11, C++14, C89, C99, Objective-C, and - Objective-C++. + writing, it supports C++98/03, C++11, C++14, C++17, C89, C99, Objective-C, + and Objective-C++. On the downside, for large projects using Clang as code model is slower than using the built-in code model. Clang does not need to generate object files, @@ -94,11 +94,27 @@ \li Syntactic and semantic highlighting \li Diagnostics \li Tooltips + \li Clang-Tidy and Clazy checks + \li Renaming of local symbols \endlist To use the plugin, you must activate it and configure it in \QC. + \section1 Using Clang-Tidy and Clazy + + \l{https://clang.llvm.org/extra/clang-tidy/}{Clang-Tidy} and + \l{https://github.com/KDE/clazy/blob/master/README.md}{Clazy} are delivered + as parts of the Clang library delivered with \QC. + + Clang-Tidy provides an extensible framework for diagnosing and fixing + typical programming errors, such as style violations, interface misuse, or + issues that can be found via static analysis. + + Clazy helps Clang understand Qt semantics. It prints out Qt related compiler + warnings, ranging from unnecessary memory allocation to misuse of API and + provides refactoring actions for fixing some of the issues. + \section1 Activating Clang Code Model If you build \QC yourself, ensure that the plugin is also built, as @@ -176,6 +192,9 @@ {Options to Request or Suppress Warnings} or the GCC or Clang manual pages. + \li In the \uicontrol {Clang Plugins} field, select the Clang-Tidy and + Clazy checks to perform. + \endlist You can specify Clang settings at project level in the build settings of |
