feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Describe suppressing and filtering Clang-Tidy diagnostics

Browse Source 
Task-number: QTCREATORBUG-30604
Change-Id: I259f5484c86b96e31c0cdb4f796d11c2a6afec2a
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
This commit is contained in:
Leena Miettinen
2024-06-21 15:07:00 +02:00
parent 9d65a003d7
commit dc2af02fa0
3 changed files with 31 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/qtcreator/images/qtcreator-clang-tidy-view.webp
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 3.5 KiB

After

Width:  |  Height:  |  Size: 9.7 KiB

BIN
doc/qtcreator/images/qtcreator-clang-tools-filter-diagnostics.webp Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 11 KiB

38
doc/qtcreator/src/analyze/creator-clang-static-analyzer.qdoc
View File

@@ -77,6 +77,37 @@
Select the \inlineimage icons/settings.png Select the \inlineimage icons/settings.png
button to customize diagnostics for the current project. button to customize diagnostics for the current project.
\section2 Filter dianostics
To filter diagnostics:
\list 1
\li Select \inlineimage icons/filtericon.png to open the
\uicontrol {Filter Diagnostics} dialog.
\image qtcreator-clang-tools-filter-diagnostics.webp {Filter Diagnostics dialog}
\li Select the diagnostics to view.
\li Select \uicontrol OK.
\endlist
To view all diagnostics, select \uicontrol {Select All}. To view diagnostics
that have fixits, select \uicontrol {Select All with Fixits}.
To hide all diagnostics, select \uicontrol {Clear Selection}.
To view diagnostics of a particular kind, right-click an entry in
\uicontrol Diagnostics and select \uicontrol {Filter for This Diagnostic Kind}
in the context menu. To hide diagnostics of that kind, select
\uicontrol {Filter out This Diagnostic Kind}.
\section2 Suppress diagnostics
To suppress diagnostics, select \uicontrol {Suppress This Diagnostic} or
\uicontrol {Suppress This Diagnostic Inline} in the context menu.
To view the suppression list for a project and to remove
diagnostics from it, select \uicontrol Projects >
\uicontrol {Project Settings} > \uicontrol {Clang Tools}.
\section1 Disable checks \section1 Disable checks
To disable checks of a particular type either globally or for a To disable checks of a particular type either globally or for a
@@ -256,13 +287,6 @@
\endlist \endlist
\section2 Suppressing Diagnostics
To suppress diagnostics, select \uicontrol {Suppress This Diagnostic} in the
context menu. To view the suppression list for a project and to remove
diagnostics from it, select \uicontrol Projects >
\uicontrol {Project Settings} > \uicontrol {Clang Tools}.
\section2 Selecting Clazy Check Levels \section2 Selecting Clazy Check Levels
The Clazy checks are divided into levels from 0 to 3. The checks at level 0 The Clazy checks are divided into levels from 0 to 3. The checks at level 0