File: avoid-const-params-in-decls.rst

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (25 lines) | stat: -rw-r--r-- 620 bytes parent folder | download | duplicates (14) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
.. title:: clang-tidy - readability-avoid-const-params-in-decls

readability-avoid-const-params-in-decls
=======================================

Checks whether a function declaration has parameters that are top level
``const``.

``const`` values in declarations do not affect the signature of a function, so
they should not be put there.

Examples:

.. code-block:: c++

  void f(const string);   // Bad: const is top level.
  void f(const string&);  // Good: const is not top level.

Options
-------

.. option:: IgnoreMacros

   If set to `true`, the check will not give warnings inside macros. Default
   is `true`.