Skip to content

[clang-tidy][NFC] improve documentation for bugprone-argument-comment check #133436

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 28, 2025
Merged

[clang-tidy][NFC] improve documentation for bugprone-argument-comment check #133436

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 16 additions & 9 deletions clang-tools-extra/docs/clang-tidy/checks/bugprone/argument-comment.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,19 @@ Options

.. option:: StrictMode

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

.. option:: IgnoreSingleArgument

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

.. option:: CommentBoolLiterals

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

Before:

Expand All @@ -55,8 +56,9 @@ After:

.. option:: CommentIntegerLiterals

When true, the check will add argument comments in the format
When `true`, the check will add argument comments in the format
``/*ParameterName=*/`` right before the integer literal argument.
Default is `false`.

Before:

Expand All @@ -76,8 +78,9 @@ After:

.. option:: CommentFloatLiterals

When true, the check will add argument comments in the format
When `true`, the check will add argument comments in the format
``/*ParameterName=*/`` right before the float/double literal argument.
Default is `false`.

Before:

Expand All @@ -97,8 +100,9 @@ After:

.. option:: CommentStringLiterals

When true, the check will add argument comments in the format
When `true`, the check will add argument comments in the format
``/*ParameterName=*/`` right before the string literal argument.
Default is `false`.

Before:

Expand All @@ -122,8 +126,9 @@ After:

.. option:: CommentCharacterLiterals

When true, the check will add argument comments in the format
When `true`, the check will add argument comments in the format
``/*ParameterName=*/`` right before the character literal argument.
Default is `false`.

Before:

Expand All @@ -143,8 +148,9 @@ After:

.. option:: CommentUserDefinedLiterals

When true, the check will add argument comments in the format
When `true`, the check will add argument comments in the format
``/*ParameterName=*/`` right before the user defined literal argument.
Default is `false`.

Before:

Expand All @@ -168,8 +174,9 @@ After:

.. option:: CommentNullPtrs

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

Before:

Expand Down