Skip to content

Commit c9a4c7a

Browse files
committed
Added first available version for clang-tidy checks options
1 parent 2563309 commit c9a4c7a

File tree

149 files changed

+592
-592
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

149 files changed

+592
-592
lines changed

clang-tools-extra/docs/clang-tidy/checks/abseil/string-find-startswith.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,18 @@ becomes
3131
Options
3232
-------
3333

34-
.. option:: StringLikeClasses
34+
.. option:: StringLikeClasses (added in 15.0.0, removed in 22.0.0)
3535

3636
Semicolon-separated list of names of string-like classes. By default both
3737
``std::basic_string`` and ``std::basic_string_view`` are considered. The list
3838
of methods to be considered is fixed.
3939

40-
.. option:: IncludeStyle
40+
.. option:: IncludeStyle (added in 15.0.0, removed in 22.0.0)
4141

4242
A string specifying which include-style is used, `llvm` or `google`. Default
4343
is `llvm`.
4444

45-
.. option:: AbseilStringsMatchHeader
45+
.. option:: AbseilStringsMatchHeader (added in 15.0.0, removed in 22.0.0)
4646

4747
The location of Abseil's ``strings/match.h``. Defaults to
4848
``absl/strings/match.h``.

clang-tools-extra/docs/clang-tidy/checks/abseil/string-find-str-contains.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,18 @@ becomes
3535
Options
3636
-------
3737

38-
.. option:: StringLikeClasses
38+
.. option:: StringLikeClasses (added in 15.0.0, removed in 22.0.0)
3939

4040
Semicolon-separated list of names of string-like classes. By default includes
4141
``::std::basic_string``, ``::std::basic_string_view``, and
4242
``::absl::string_view``.
4343

44-
.. option:: IncludeStyle
44+
.. option:: IncludeStyle (added in 15.0.0, removed in 22.0.0)
4545

4646
A string specifying which include-style is used, `llvm` or `google`. Default
4747
is `llvm`.
4848

49-
.. option:: AbseilStringsMatchHeader
49+
.. option:: AbseilStringsMatchHeader (added in 15.0.0, removed in 22.0.0)
5050

5151
The location of Abseil's ``strings/match.h``. Defaults to
5252
``absl/strings/match.h``.

clang-tools-extra/docs/clang-tidy/checks/altera/single-work-item-barrier.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Examples:
5252
Options
5353
-------
5454

55-
.. option:: AOCVersion
55+
.. option:: AOCVersion (added in 15.0.0, removed in 22.0.0)
5656

5757
Defines the version of the Altera Offline Compiler. Defaults to ``1600``
5858
(corresponding to version 16.00).

clang-tools-extra/docs/clang-tidy/checks/altera/unroll-loops.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ Based on the `Altera SDK for OpenCL: Best Practices Guide
9696
Options
9797
-------
9898

99-
.. option:: MaxLoopIterations
99+
.. option:: MaxLoopIterations (added in 15.0.0, removed in 22.0.0)
100100

101101
Defines the maximum number of loop iterations that a fully unrolled loop
102102
can have. By default, it is set to `100`.

clang-tools-extra/docs/clang-tidy/checks/android/comparison-in-temp-failure-retry.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ If you encounter this, the fix is simple: lift the comparison out of the
3838
Options
3939
-------
4040

41-
.. option:: RetryMacros
41+
.. option:: RetryMacros (added in 15.0.0, removed in 22.0.0)
4242

4343
A comma-separated list of the names of retry macros to be checked.
4444
Default is `TEMP_FAILURE_RETRY`.

clang-tools-extra/docs/clang-tidy/checks/boost/use-ranges.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -160,18 +160,18 @@ Transforms to:
160160
Options
161161
-------
162162

163-
.. option:: IncludeStyle
163+
.. option:: IncludeStyle (added in 19.1.0, removed in 22.0.0)
164164

165165
A string specifying which include-style is used, `llvm` or `google`. Default
166166
is `llvm`.
167167

168-
.. option:: IncludeBoostSystem
168+
.. option:: IncludeBoostSystem (added in 19.1.0, removed in 22.0.0)
169169

170170
If `true` (default value) the boost headers are included as system headers
171171
with angle brackets (`#include <boost.hpp>`), otherwise quotes are used
172172
(`#include "boost.hpp"`).
173173

174-
.. option:: UseReversePipe
174+
.. option:: UseReversePipe (added in 19.1.0, removed in 22.0.0)
175175

176176
When `true` (default `false`), fixes which involve reverse ranges will use the
177177
pipe adaptor syntax instead of the function syntax.

clang-tools-extra/docs/clang-tidy/checks/bugprone/argument-comment.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,17 @@ The check tries to detect typos and suggest automated fixes for them.
2222
Options
2323
-------
2424

25-
.. option:: StrictMode
25+
.. option:: StrictMode (added in 15.0.0, removed in 22.0.0)
2626

2727
When `false`, the check will ignore leading and trailing
2828
underscores and case when comparing names -- otherwise they are taken into
2929
account. Default is `false`.
3030

31-
.. option:: IgnoreSingleArgument
31+
.. option:: IgnoreSingleArgument (added in 15.0.0, removed in 22.0.0)
3232

3333
When `true`, the check will ignore the single argument. Default is `false`.
3434

35-
.. option:: CommentBoolLiterals
35+
.. option:: CommentBoolLiterals (added in 15.0.0, removed in 22.0.0)
3636

3737
When `true`, the check will add argument comments in the format
3838
``/*ParameterName=*/`` right before the boolean literal argument.
@@ -54,7 +54,7 @@ After:
5454

5555
foo(/*TurnKey=*/true, /*PressButton=*/false);
5656

57-
.. option:: CommentIntegerLiterals
57+
.. option:: CommentIntegerLiterals (added in 15.0.0, removed in 22.0.0)
5858

5959
When `true`, the check will add argument comments in the format
6060
``/*ParameterName=*/`` right before the integer literal argument.
@@ -76,7 +76,7 @@ After:
7676

7777
foo(/*MeaningOfLife=*/42);
7878

79-
.. option:: CommentFloatLiterals
79+
.. option:: CommentFloatLiterals (added in 15.0.0, removed in 22.0.0)
8080

8181
When `true`, the check will add argument comments in the format
8282
``/*ParameterName=*/`` right before the float/double literal argument.
@@ -98,7 +98,7 @@ After:
9898

9999
foo(/*Pi=*/3.14159);
100100

101-
.. option:: CommentStringLiterals
101+
.. option:: CommentStringLiterals (added in 15.0.0, removed in 22.0.0)
102102

103103
When `true`, the check will add argument comments in the format
104104
``/*ParameterName=*/`` right before the string literal argument.
@@ -124,7 +124,7 @@ After:
124124
foo(/*String=*/"Hello World");
125125
foo(/*WideString=*/L"Hello World");
126126

127-
.. option:: CommentCharacterLiterals
127+
.. option:: CommentCharacterLiterals (added in 15.0.0, removed in 22.0.0)
128128

129129
When `true`, the check will add argument comments in the format
130130
``/*ParameterName=*/`` right before the character literal argument.
@@ -146,7 +146,7 @@ After:
146146
147147
foo(/*Character=*/'A');
148148

149-
.. option:: CommentUserDefinedLiterals
149+
.. option:: CommentUserDefinedLiterals (added in 15.0.0, removed in 22.0.0)
150150

151151
When `true`, the check will add argument comments in the format
152152
``/*ParameterName=*/`` right before the user defined literal argument.
@@ -172,7 +172,7 @@ After:
172172

173173
foo(/*Distance=*/402.0_km);
174174

175-
.. option:: CommentNullPtrs
175+
.. option:: CommentNullPtrs (added in 15.0.0, removed in 22.0.0)
176176

177177
When `true`, the check will add argument comments in the format
178178
``/*ParameterName=*/`` right before the nullptr literal argument.

clang-tools-extra/docs/clang-tidy/checks/bugprone/assert-side-effect.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@ builds.
1212
Options
1313
-------
1414

15-
.. option:: AssertMacros
15+
.. option:: AssertMacros (added in 15.0.0, removed in 22.0.0)
1616

1717
A comma-separated list of the names of assert macros to be checked.
1818
Default is `assert,NSAssert,NSCAssert`.
1919

20-
.. option:: CheckFunctionCalls
20+
.. option:: CheckFunctionCalls (added in 15.0.0, removed in 22.0.0)
2121

2222
Whether to treat non-const member and non-member functions as they produce
2323
side effects. Disabled by default because it can increase the number of false
2424
positive warnings.
2525

26-
.. option:: IgnoredFunctions
26+
.. option:: IgnoredFunctions (added in 15.0.0, removed in 22.0.0)
2727

2828
A semicolon-separated list of the names of functions or methods to be
2929
considered as not having side-effects. Regular expressions are accepted,

clang-tools-extra/docs/clang-tidy/checks/bugprone/capturing-this-in-member-variable.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@ Possible fixes:
3535
Options
3636
-------
3737

38-
.. option:: FunctionWrapperTypes
38+
.. option:: FunctionWrapperTypes (added in 21.1.0, removed in 22.0.0)
3939

4040
A semicolon-separated list of names of types. Used to specify function
4141
wrapper that can hold lambda expressions.
4242
Default is `::std::function;::std::move_only_function;::boost::function`.
4343

44-
.. option:: BindFunctions
44+
.. option:: BindFunctions (added in 21.1.0, removed in 22.0.0)
4545

4646
A semicolon-separated list of fully qualified names of functions that can
4747
capture ``this`` pointer.

clang-tools-extra/docs/clang-tidy/checks/bugprone/dangling-handle.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Examples:
3838
Options
3939
-------
4040

41-
.. option:: HandleClasses
41+
.. option:: HandleClasses (added in 15.0.0, removed in 22.0.0)
4242

4343
A semicolon-separated list of class names that should be treated as handles.
4444
By default only ``std::basic_string_view``,

0 commit comments

Comments
 (0)