[clang-tidy] bugprone-argument-comment: Ignore calls to user-defined literals

[jspam]

Summary

Without this change, code such as "f(/*param=*/1_op)" will check the
comment twice, once for the parameter of f (correct) and once for
the parameter of operator""_op (likely incorrect). The change removes
only the second check.

[jspam]

Fix test

[LegalizeAdulthood]

LGTM

[njames93]

These tests aren't that great.
I'd advise adding a test that just checks using the userDefinedLiteral in bugprone-argument-comment-literals.cpp, That check file will add comments to parameters that don't have them.
That way you aren't testing against distinguishing between the actual parameter comment and the literal comment.
This simple edit without your fix results in this diff in the output, with your fix that diff wont exist.

[build]  int operator""_op(unsigned long long Value);
[build]  
[build]  void test() {
[build] -  1_op;
[build] +  /*Value=*/1_op;

[jspam]

Update test as suggested by njames93.

bugprone-argument-comment-literals.cpp also contains some instances of a UDL used as an argument which didn't lead to problems before because the argument didn't have a name. So that case is covered as well.

[jspam]

Would someone be able to commit this for me, as I do not have the necessary rights? Thanks

[njames93]

In D125885#3595301, @jspam wrote:

Would someone be able to commit this for me, as I do not have the necessary rights? Thanks

I can for you, what name and email address should I use?

[jspam]

Thanks. Please use Joachim Priesner <[e-mail]>

clang-tools-extra/clang-tidy/bugprone/ArgumentCommentCheck.cpp

void ArgumentCommentCheck::storeOptions(ClangTidyOptions::OptionMap &Opts) {
   Options.store(Opts, "CommentStringLiterals", CommentStringLiterals);
   Options.store(Opts, "CommentUserDefinedLiterals", CommentUserDefinedLiterals);
   Options.store(Opts, "CommentCharacterLiterals", CommentCharacterLiterals);
   Options.store(Opts, "CommentNullPtrs", CommentNullPtrs);
 }
 
 void ArgumentCommentCheck::registerMatchers(MatchFinder *Finder) {
   Finder->addMatcher(
-      callExpr(unless(cxxOperatorCallExpr()),
+      callExpr(unless(cxxOperatorCallExpr()), unless(userDefinedLiteral()),
                // NewCallback's arguments relate to the pointed function,
                // don't check them against NewCallback's parameter names.
                // FIXME: Make this configurable.
                unless(hasDeclaration(functionDecl(
                    hasAnyName("NewCallback", "NewPermanentCallback")))),
                // Ignore APIs from the standard library, since their names are
                // not specified by the standard, and standard library
                // implementations in practice have to use reserved names to

clang-tools-extra/test/clang-tidy/checkers/bugprone-argument-comment-literals.cpp

 #define FOO 1
 #define X(x) (x)
 
 void g(int a);
 void h(double b);
 void i(const char *c);
 void j(int a, int b, int c);
 
-double operator"" _km(long double);
+double operator"" _km(long double value);
 
 void test() {
   A a;
 
   a.foo(true);
   // CHECK-MESSAGES: [[@LINE-1]]:9: warning: argument comment missing for literal argument 'abc' [bugprone-argument-comment]
   // CHECK-FIXES: a.foo(/*abc=*/true);
 
void test() {
   // CHECK-MESSAGES: [[@LINE-2]]:8: warning: argument comment missing for literal argument 'b' [bugprone-argument-comment]
   // CHECK-FIXES: j(/*a=*/1, /*b=*/1, X(1));
   j(/*a=*/1, /*b=*/1, X(1));
 
   // FIXME Would like the below to add argument comments.
   g((1));
   // FIXME But we should not add argument comments here.
   g(_Generic(0, int : 0));
+
+  402.0_km;
 }
 
 void f(bool _with_underscores_);
 void ignores_underscores() {
   f(false);
   // CHECK-MESSAGES: [[@LINE-1]]:5: warning: argument comment missing for literal argument '_with_underscores_' [bugprone-argument-comment]
   // CHECK-FIXES: f(/*_with_underscores_=*/false);
 
   f(true);
   // CHECK-MESSAGES: [[@LINE-1]]:5: warning: argument comment missing for literal argument
   // CHECK-FIXES: f(/*_with_underscores_=*/true);
 }