Skip to content

Commit ecdbd26

Browse files
authored
[clang-tidy][NFC] improve documentation for bugprone-argument-comment check (#133436)
Improve docs for `bugprone-argument-comment` check by writing explicitly default values for options. Before this change, it was unclear what values are default.
1 parent 316bb89 commit ecdbd26

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

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

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,19 @@ Options
2424

2525
.. option:: StrictMode
2626

27-
When `false` (default value), the check will ignore leading and trailing
27+
When `false`, the check will ignore leading and trailing
2828
underscores and case when comparing names -- otherwise they are taken into
29-
account.
29+
account. Default is `false`.
3030

3131
.. option:: IgnoreSingleArgument
3232

33-
When `true`, the check will ignore the single argument.
33+
When `true`, the check will ignore the single argument. Default is `false`.
3434

3535
.. option:: CommentBoolLiterals
3636

3737
When `true`, the check will add argument comments in the format
3838
``/*ParameterName=*/`` right before the boolean literal argument.
39+
Default is `false`.
3940

4041
Before:
4142

@@ -55,8 +56,9 @@ After:
5556

5657
.. option:: CommentIntegerLiterals
5758

58-
When true, the check will add argument comments in the format
59+
When `true`, the check will add argument comments in the format
5960
``/*ParameterName=*/`` right before the integer literal argument.
61+
Default is `false`.
6062

6163
Before:
6264

@@ -76,8 +78,9 @@ After:
7678

7779
.. option:: CommentFloatLiterals
7880

79-
When true, the check will add argument comments in the format
81+
When `true`, the check will add argument comments in the format
8082
``/*ParameterName=*/`` right before the float/double literal argument.
83+
Default is `false`.
8184

8285
Before:
8386

@@ -97,8 +100,9 @@ After:
97100

98101
.. option:: CommentStringLiterals
99102

100-
When true, the check will add argument comments in the format
103+
When `true`, the check will add argument comments in the format
101104
``/*ParameterName=*/`` right before the string literal argument.
105+
Default is `false`.
102106

103107
Before:
104108

@@ -122,8 +126,9 @@ After:
122126

123127
.. option:: CommentCharacterLiterals
124128

125-
When true, the check will add argument comments in the format
129+
When `true`, the check will add argument comments in the format
126130
``/*ParameterName=*/`` right before the character literal argument.
131+
Default is `false`.
127132

128133
Before:
129134

@@ -143,8 +148,9 @@ After:
143148

144149
.. option:: CommentUserDefinedLiterals
145150

146-
When true, the check will add argument comments in the format
151+
When `true`, the check will add argument comments in the format
147152
``/*ParameterName=*/`` right before the user defined literal argument.
153+
Default is `false`.
148154

149155
Before:
150156

@@ -168,8 +174,9 @@ After:
168174

169175
.. option:: CommentNullPtrs
170176

171-
When true, the check will add argument comments in the format
177+
When `true`, the check will add argument comments in the format
172178
``/*ParameterName=*/`` right before the nullptr literal argument.
179+
Default is `false`.
173180

174181
Before:
175182

0 commit comments

Comments
 (0)