File tree Expand file tree Collapse file tree 15 files changed +33
-18
lines changed Expand file tree Collapse file tree 15 files changed +33
-18
lines changed Original file line number Diff line number Diff line change @@ -41,3 +41,4 @@ Options
4141.. option :: RetryMacros
4242
4343 A comma-separated list of the names of retry macros to be checked.
44+ Default is `TEMP_FAILURE_RETRY `.
Original file line number Diff line number Diff line change @@ -37,4 +37,4 @@ Options
3737.. option :: DisallowedSeedTypes
3838
3939 A comma-separated list of the type names which are disallowed.
40- Default values are `` time_t ``, `` std::time_t ` `.
40+ Default value is ` time_t, std::time_t `.
Original file line number Diff line number Diff line change @@ -32,6 +32,9 @@ Examples:
3232
3333 sleep(1); // implementation may use SIGALRM
3434
35+ Options
36+ -------
37+
3538.. option :: FunctionSet
3639
3740 Specifies which functions in libc should be considered thread-safe,
Original file line number Diff line number Diff line change @@ -35,14 +35,14 @@ Options
3535.. option :: Allocations
3636
3737 Semicolon-separated list of fully qualified names of memory allocation functions.
38- Defaults to `` ::malloc;::calloc ` `.
38+ Defaults to `::malloc;::calloc `.
3939
4040.. option :: Deallocations
4141
4242 Semicolon-separated list of fully qualified names of memory allocation functions.
43- Defaults to `` ::free ` `.
43+ Defaults to `::free `.
4444
4545.. option :: Reallocations
4646
4747 Semicolon-separated list of fully qualified names of memory allocation functions.
48- Defaults to `` ::realloc ` `.
48+ Defaults to `::realloc `.
Original file line number Diff line number Diff line change @@ -95,14 +95,14 @@ Options
9595
9696 Semicolon-separated list of fully qualified names of legacy functions that create
9797 resources but cannot introduce ``gsl::owner<> ``.
98- Defaults to `` ::malloc;::aligned_alloc;::realloc;::calloc;::fopen;::freopen;::tmpfile ` `.
98+ Defaults to `::malloc;::aligned_alloc;::realloc;::calloc;::fopen;::freopen;::tmpfile `.
9999
100100
101101.. option :: LegacyResourceConsumers
102102
103103 Semicolon-separated list of fully qualified names of legacy functions expecting
104104 resource owners as pointer arguments but cannot introduce ``gsl::owner<> ``.
105- Defaults to `` ::free;::realloc;::freopen;::fclose ` `.
105+ Defaults to `::free;::realloc;::freopen;::fclose `.
106106
107107
108108Limitations
Original file line number Diff line number Diff line change @@ -21,6 +21,7 @@ Options
2121
2222 The check can generate fixes after this option has been set to the name of
2323 the include file that contains ``gsl::at() ``, e.g. `"gsl/gsl.h" `.
24+ Default is an empty string.
2425
2526.. option :: IncludeStyle
2627
Original file line number Diff line number Diff line change @@ -37,6 +37,7 @@ Options
3737
3838 If set to `true `, the check will provide fix-its with literal initializers
3939 \( ``int i = 0; `` \) instead of curly braces \( ``int i{}; `` \) .
40+ Default is `false `.
4041
4142This rule is part of the `Type safety (Type.6)
4243<https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Pro-type-memberinit> `_
Original file line number Diff line number Diff line change @@ -45,8 +45,8 @@ Options
4545
4646 A semicolon-separated list of qualified types which should not be allowed to
4747 persist across suspension points.
48- Eg: `` my::lockable; a::b;::my::other::lockable; ` `
49- The default value of this option is `" std::lock_guard;std::scoped_lock" `.
48+ Eg: `my::lockable;a::b;::my::other::lockable `
49+ The default value of this option is `std::lock_guard;std::scoped_lock `.
5050
5151.. option :: AllowedAwaitablesList
5252
@@ -78,6 +78,6 @@ Options
7878 co_await wait();
7979 }
8080
81- Eg: `` my::safe::awaitable;other::awaitable ` `
82- The default value of this option is empty string ` "" ` .
81+ Eg: `my::safe::awaitable;other::awaitable `
82+ Default is an empty string.
8383
Original file line number Diff line number Diff line change @@ -31,8 +31,8 @@ Options
3131
3232 A semicolon-separated list of regexes to disable insertion/removal of header
3333 files that match this regex as a suffix. E.g., `foo/.* ` disables
34- insertion/removal for all headers under the directory `foo `. By default, no
35- headers will be ignored.
34+ insertion/removal for all headers under the directory `foo `. Default is an
35+ empty string, no headers will be ignored.
3636
3737.. option :: DeduplicateFindings
3838
Original file line number Diff line number Diff line change @@ -17,10 +17,11 @@ Options
1717
1818.. option :: IgnoreClassesWithAllMemberVariablesBeingPublic
1919
20- Allows to completely ignore classes if **all ** the member variables in that
21- class a declared with a ``public `` access specifier.
20+ When `true `, allows to completely ignore classes if **all ** the member
21+ variables in that class declared with a ``public `` access specifier.
22+ Default is `false `.
2223
2324.. option :: IgnorePublicMemberVariables
2425
25- Allows to ignore (not diagnose) **all ** the member variables declared with
26- a ``public `` access specifier.
26+ When ` true `, allows to ignore (not diagnose) **all ** the member variables
27+ declared with a ``public `` access specifier. Default is ` false ` .
You can’t perform that action at this time.
0 commit comments