maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

[clang-tidy] Add a separate section for NOLINT(NEXTLINE)? doc. 

llvm-svn: 345049
This commit is contained in:
Alexander Kornienko 2018-10-23 16:48:16 +00:00
parent f04a04c2b6
commit 3885b49b8e
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
clang-tools-extra/docs/clang-tidy/index.rst
View File

@ -255,16 +255,19 @@ An overview of all the command-line options:
value: 'some value'
...
Suppressing Undesired Diagnostics
=================================
:program:`clang-tidy` diagnostics are intended to call out code that does
not adhere to a coding standard, or is otherwise problematic in some way.
However, if it is known that the code is correct, the check-specific ways
to silence the diagnostics could be used, if they are available (e.g.
bugprone-use-after-move can be silenced by re-initializing the variable after
it has been moved out, misc-string-integer-assignment can be suppressed by
explicitly casting the integer to char, readability-implicit-bool-conversion
can also be suppressed by using explicit casts, etc.). If they are not
available or if changing the semantics of the code is not desired,
the ``NOLINT`` or ``NOLINTNEXTLINE`` comments can be used instead. For example:
to silence the diagnostics could be used, if they are available (e.g.
bugprone-use-after-move can be silenced by re-initializing the variable after it
has been moved out, bugprone-string-integer-assignment can be suppressed by
explicitly casting the integer to char, readability-implicit-bool-conversion can
also be suppressed by using explicit casts, etc.). If they are not available or
if changing the semantics of the code is not desired, the ``NOLINT`` or
``NOLINTNEXTLINE`` comments can be used instead. For example:
.. code-block:: c++