[docs] Add LICENSE.txt to the root of the mono-repo
[llvm-project.git] / clang-tools-extra / docs / clang-tidy / checks / readability / redundant-declaration.rst
blob2a7ecac73c4c1a54f6877039cf78ecb61d54b7a7
1 .. title:: clang-tidy - readability-redundant-declaration
3 readability-redundant-declaration
4 =================================
6 Finds redundant variable and function declarations.
8 .. code-block:: c++
10   extern int X;
11   extern int X;
13 becomes
15 .. code-block:: c++
17   extern int X;
19 Such redundant declarations can be removed without changing program behavior.
20 They can for instance be unintentional left overs from previous refactorings
21 when code has been moved around. Having redundant declarations could in worst
22 case mean that there are typos in the code that cause bugs.
24 Normally the code can be automatically fixed, :program:`clang-tidy` can remove
25 the second declaration. However there are 2 cases when you need to fix the code
26 manually:
28 * When the declarations are in different header files;
29 * When multiple variables are declared together.
31 Options
32 -------
34 .. option:: IgnoreMacros
36    If set to `true`, the check will not give warnings inside macros. Default
37    is `true`.