[clang-tools-extra] [clang-tidy][NFC] improve documentation for `bugprone-argument-comment` check (PR #133436)
Baranov Victor via cfe-commits
cfe-commits at lists.llvm.org
Fri Mar 28 05:35:37 PDT 2025
https://github.com/vbvictor created https://github.com/llvm/llvm-project/pull/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.
>From 916062c02019d805f94f494e9ded33c0f40462e2 Mon Sep 17 00:00:00 2001
From: Victor Baranov <bar.victor.2002 at gmail.com>
Date: Fri, 28 Mar 2025 15:33:02 +0300
Subject: [PATCH] [clang-tidy][NFC] improve documentation for
`bugprone-argument-comment` check
---
.../checks/bugprone/argument-comment.rst | 25 ++++++++++++-------
1 file changed, 16 insertions(+), 9 deletions(-)
diff --git a/clang-tools-extra/docs/clang-tidy/checks/bugprone/argument-comment.rst b/clang-tools-extra/docs/clang-tidy/checks/bugprone/argument-comment.rst
index ab7e668b971c0..8770d7224137a 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/bugprone/argument-comment.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/bugprone/argument-comment.rst
@@ -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:
@@ -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:
@@ -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:
@@ -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:
@@ -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:
@@ -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:
@@ -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:
More information about the cfe-commits
mailing list