@@ -24,18 +24,19 @@ Options
24
24
25
25
.. option :: StrictMode
26
26
27
- When `false ` (default value) , the check will ignore leading and trailing
27
+ When `false `, the check will ignore leading and trailing
28
28
underscores and case when comparing names -- otherwise they are taken into
29
- account.
29
+ account. Default is ` false `.
30
30
31
31
.. option :: IgnoreSingleArgument
32
32
33
- When `true `, the check will ignore the single argument.
33
+ When `true `, the check will ignore the single argument. Default is ` false `.
34
34
35
35
.. option :: CommentBoolLiterals
36
36
37
37
When `true `, the check will add argument comments in the format
38
38
``/*ParameterName=*/ `` right before the boolean literal argument.
39
+ Default is `false `.
39
40
40
41
Before:
41
42
55
56
56
57
.. option :: CommentIntegerLiterals
57
58
58
- When true, the check will add argument comments in the format
59
+ When ` true ` , the check will add argument comments in the format
59
60
``/*ParameterName=*/ `` right before the integer literal argument.
61
+ Default is `false `.
60
62
61
63
Before:
62
64
76
78
77
79
.. option :: CommentFloatLiterals
78
80
79
- When true, the check will add argument comments in the format
81
+ When ` true ` , the check will add argument comments in the format
80
82
``/*ParameterName=*/ `` right before the float/double literal argument.
83
+ Default is `false `.
81
84
82
85
Before:
83
86
@@ -97,8 +100,9 @@ After:
97
100
98
101
.. option :: CommentStringLiterals
99
102
100
- When true, the check will add argument comments in the format
103
+ When ` true ` , the check will add argument comments in the format
101
104
``/*ParameterName=*/ `` right before the string literal argument.
105
+ Default is `false `.
102
106
103
107
Before:
104
108
@@ -122,8 +126,9 @@ After:
122
126
123
127
.. option :: CommentCharacterLiterals
124
128
125
- When true, the check will add argument comments in the format
129
+ When ` true ` , the check will add argument comments in the format
126
130
``/*ParameterName=*/ `` right before the character literal argument.
131
+ Default is `false `.
127
132
128
133
Before:
129
134
@@ -143,8 +148,9 @@ After:
143
148
144
149
.. option :: CommentUserDefinedLiterals
145
150
146
- When true, the check will add argument comments in the format
151
+ When ` true ` , the check will add argument comments in the format
147
152
``/*ParameterName=*/ `` right before the user defined literal argument.
153
+ Default is `false `.
148
154
149
155
Before:
150
156
@@ -168,8 +174,9 @@ After:
168
174
169
175
.. option :: CommentNullPtrs
170
176
171
- When true, the check will add argument comments in the format
177
+ When ` true ` , the check will add argument comments in the format
172
178
``/*ParameterName=*/ `` right before the nullptr literal argument.
179
+ Default is `false `.
173
180
174
181
Before:
175
182
0 commit comments