summaryrefslogtreecommitdiffstats
path: root/clang-tools-extra/docs/clang-tidy/checks/misc-argument-comment.rst
blob: 872d4783c4b6ae05cf6ab080953efe8f16ce2a25 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
.. title:: clang-tidy - misc-argument-comment

misc-argument-comment
=====================


Checks that argument comments match parameter names.

The check understands argument comments in the form ``/*parameter_name=*/``
that are placed right before the argument.

.. code:: c++

  void f(bool foo);

  ...
  f(/*bar=*/true);
  // warning: argument name 'bar' in comment does not match parameter name 'foo'

The check tries to detect typos and suggest automated fixes for them.
OpenPOWER on IntegriCloud