Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions clang-tools-extra/docs/_static/clang-tools-extra-styles.css
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,6 @@ details summary:hover {
background-color: rgba(50, 150, 220, 0.2);
cursor: pointer;
}
.strike {
text-decoration: line-through;
}
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,18 @@ becomes
Options
-------

.. option:: StringLikeClasses
.. option:: StringLikeClasses (added in 15.0.0)

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

.. option:: IncludeStyle
.. option:: IncludeStyle (added in 15.0.0)

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

.. option:: AbseilStringsMatchHeader
.. option:: AbseilStringsMatchHeader (added in 15.0.0)

The location of Abseil's ``strings/match.h``. Defaults to
``absl/strings/match.h``.
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,18 @@ becomes
Options
-------

.. option:: StringLikeClasses
.. option:: StringLikeClasses (added in 15.0.0)

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

.. option:: IncludeStyle
.. option:: IncludeStyle (added in 15.0.0)

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

.. option:: AbseilStringsMatchHeader
.. option:: AbseilStringsMatchHeader (added in 15.0.0)

The location of Abseil's ``strings/match.h``. Defaults to
``absl/strings/match.h``.
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Examples:
Options
-------

.. option:: AOCVersion
.. option:: AOCVersion (added in 15.0.0)

Defines the version of the Altera Offline Compiler. Defaults to ``1600``
(corresponding to version 16.00).
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Based on the `Altera SDK for OpenCL: Best Practices Guide
Options
-------

.. option:: MaxLoopIterations
.. option:: MaxLoopIterations (added in 15.0.0)

Defines the maximum number of loop iterations that a fully unrolled loop
can have. By default, it is set to `100`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ If you encounter this, the fix is simple: lift the comparison out of the
Options
-------

.. option:: RetryMacros
.. option:: RetryMacros (added in 15.0.0)

A comma-separated list of the names of retry macros to be checked.
Default is `TEMP_FAILURE_RETRY`.
6 changes: 3 additions & 3 deletions clang-tools-extra/docs/clang-tidy/checks/boost/use-ranges.rst
Original file line number Diff line number Diff line change
Expand Up @@ -160,18 +160,18 @@ Transforms to:
Options
-------

.. option:: IncludeStyle
.. option:: IncludeStyle (added in 19.1.0)

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

.. option:: IncludeBoostSystem
.. option:: IncludeBoostSystem (added in 19.1.0)

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

.. option:: UseReversePipe
.. option:: UseReversePipe (added in 19.1.0)

When `true` (default `false`), fixes which involve reverse ranges will use the
pipe adaptor syntax instead of the function syntax.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,17 @@ The check tries to detect typos and suggest automated fixes for them.
Options
-------

.. option:: StrictMode
.. option:: StrictMode (added in 15.0.0)

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

.. option:: IgnoreSingleArgument
.. option:: IgnoreSingleArgument (added in 15.0.0)

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

.. option:: CommentBoolLiterals
.. option:: CommentBoolLiterals (added in 15.0.0)

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

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

.. option:: CommentIntegerLiterals
.. option:: CommentIntegerLiterals (added in 15.0.0)

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

foo(/*MeaningOfLife=*/42);

.. option:: CommentFloatLiterals
.. option:: CommentFloatLiterals (added in 15.0.0)

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

foo(/*Pi=*/3.14159);

.. option:: CommentStringLiterals
.. option:: CommentStringLiterals (added in 15.0.0)

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

.. option:: CommentCharacterLiterals
.. option:: CommentCharacterLiterals (added in 15.0.0)

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

.. option:: CommentUserDefinedLiterals
.. option:: CommentUserDefinedLiterals (added in 15.0.0)

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

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

.. option:: CommentNullPtrs
.. option:: CommentNullPtrs (added in 15.0.0)

When `true`, the check will add argument comments in the format
``/*ParameterName=*/`` right before the nullptr literal argument.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,18 @@ builds.
Options
-------

.. option:: AssertMacros
.. option:: AssertMacros (added in 15.0.0)

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

.. option:: CheckFunctionCalls
.. option:: CheckFunctionCalls (added in 15.0.0)

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

.. option:: IgnoredFunctions
.. option:: IgnoredFunctions (added in 15.0.0)

A semicolon-separated list of the names of functions or methods to be
considered as not having side-effects. Regular expressions are accepted,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@ Possible fixes:
Options
-------

.. option:: FunctionWrapperTypes
.. option:: FunctionWrapperTypes (added in 21.1.0)

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

.. option:: BindFunctions
.. option:: BindFunctions (added in 21.1.0)

A semicolon-separated list of fully qualified names of functions that can
capture ``this`` pointer.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Examples:
Options
-------

.. option:: HandleClasses
.. option:: HandleClasses (added in 15.0.0)

A semicolon-separated list of class names that should be treated as handles.
By default only ``std::basic_string_view``,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ way of mixing at call sites the most.
These options are expected to make the check report for more functions, and
report longer mixable ranges.

.. option:: QualifiersMix
.. option:: QualifiersMix (added in 15.0.0)

Whether to consider parameters of some *cvr-qualified* ``T`` and a
differently *cvr-qualified* ``T`` (i.e. ``T`` and ``const T``, ``const T``
Expand All @@ -59,7 +59,7 @@ report longer mixable ranges.

void *memcpy(const void *Destination, void *Source, std::size_t N) { /* ... */ }
.. option:: ModelImplicitConversions
.. option:: ModelImplicitConversions (added in 15.0.0)

Whether to consider parameters of type ``T`` and ``U`` mixable if there
exists an implicit conversion from ``T`` to ``U`` and ``U`` to ``T``.
Expand Down Expand Up @@ -99,7 +99,7 @@ Filtering options can be used to lessen the size of the diagnostics emitted by
the checker, whether the aim is to ignore certain constructs or dampen the
noisiness.

.. option:: MinimumLength
.. option:: MinimumLength (added in 15.0.0)

The minimum length required from an adjacent parameter sequence to be
diagnosed.
Expand All @@ -109,7 +109,7 @@ noisiness.

For example, if `3` is specified, the examples above will not be matched.

.. option:: IgnoredParameterNames
.. option:: IgnoredParameterNames (added in 15.0.0)

The list of parameter **names** that should never be considered part of a
swappable adjacent parameter sequence.
Expand All @@ -123,7 +123,7 @@ noisiness.
`""` (unnamed parameters), `iterator`, `begin`, `end`, `first`, `last`,
`lhs`, `rhs`.

.. option:: IgnoredParameterTypeSuffixes
.. option:: IgnoredParameterTypeSuffixes (added in 15.0.0)

The list of parameter **type name suffixes** that should never be
considered part of a swappable adjacent parameter sequence.
Expand All @@ -140,7 +140,7 @@ noisiness.
`ConstIterator`, `const_reverse_iterator`, `ConstReverseIterator`.
In addition, `_Bool` (but not `_bool`) is also part of the default value.

.. option:: SuppressParametersUsedTogether
.. option:: SuppressParametersUsedTogether (added in 15.0.0)

Suppresses diagnostics about parameters that are used together or in a
similar fashion inside the function's body.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -126,15 +126,15 @@ and maintainable.
Options
-------

.. option:: IgnoreCatchWithKeywords
.. option:: IgnoreCatchWithKeywords (added in 17.0.1)

This option can be used to ignore specific catch statements containing
certain keywords. If a ``catch`` statement body contains (case-insensitive)
any of the keywords listed in this semicolon-separated option, then the
catch will be ignored, and no warning will be raised.
Default value: `@TODO;@FIXME`.

.. option:: AllowEmptyCatchForExceptions
.. option:: AllowEmptyCatchForExceptions (added in 17.0.1)

This option can be used to ignore empty catch statements for specific
exception types. By default, the check will raise a warning if an empty
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,14 @@ WARNING! This check may be expensive on large source files.
Options
-------

.. option:: FunctionsThatShouldNotThrow
.. option:: FunctionsThatShouldNotThrow (added in 15.0.0)

Comma separated list containing function names which should not throw. An
example value for this parameter can be ``WinMain`` which adds function
``WinMain()`` in the Windows API to the list of the functions which should
not throw. Default value is an empty string.

.. option:: IgnoredExceptions
.. option:: IgnoredExceptions (added in 15.0.0)

Comma separated list containing type names which are not counted as thrown
exceptions in the check. Default value is an empty string.
Original file line number Diff line number Diff line change
Expand Up @@ -34,18 +34,18 @@ where for that to happen you "only" need a ~269MPix image.
Options
-------

.. option:: UseCXXStaticCastsInCppSources
.. option:: UseCXXStaticCastsInCppSources (added in 15.0.0)

When suggesting fix-its for C++ code, should C++-style ``static_cast<>()``'s
be suggested, or C-style casts. Defaults to `true`.

.. option:: UseCXXHeadersInCppSources
.. option:: UseCXXHeadersInCppSources (added in 15.0.0)

When suggesting to include the appropriate header in C++ code,
should ``<cstddef>`` header be suggested, or ``<stddef.h>``.
Defaults to `true`.

.. option:: IgnoreConstantIntExpr
.. option:: IgnoreConstantIntExpr (added in 19.1.0)

If the multiplication operands are compile-time constants (like literals or
are ``constexpr``) and fit within the source expression type, do not emit a
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Likely intended output::
Options
-------

.. option:: IgnoreMacros
.. option:: IgnoreMacros (added in 18.1.0)

The value `true` specifies that attempting to get the name of a function from
within a macro should not be diagnosed. The default value is `false`.
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,6 @@ written for this code:
Options
-------

.. option:: CheckImplicitCasts
.. option:: CheckImplicitCasts (added in 15.0.0)

If `true`, enables detection of implicit casts. Default is `false`.
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ improving the overall reliability and maintainability of the code.
Options
-------

.. option:: EnableInC
.. option:: EnableInC (added in 21.1.0)

If `true`, enables the check in C code (it is always enabled in C++ code).
Default is `true`.
Loading
Loading