File: misc-misplaced-const.rst

package info (click to toggle)
llvm-toolchain-6.0 1%3A6.0.1-10
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 598,080 kB
  • sloc: cpp: 3,046,253; ansic: 595,057; asm: 271,965; python: 128,926; objc: 106,554; sh: 21,906; lisp: 10,191; pascal: 6,094; ml: 5,544; perl: 5,265; makefile: 2,227; cs: 2,027; xml: 686; php: 212; csh: 117
file content (22 lines) | stat: -rw-r--r-- 799 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
.. title:: clang-tidy - misc-misplaced-const

misc-misplaced-const
====================

This check diagnoses when a ``const`` qualifier is applied to a ``typedef`` to a
pointer type rather than to the pointee, because such constructs are often
misleading to developers because the ``const`` applies to the pointer rather
than the pointee.

For instance, in the following code, the resulting type is ``int *`` ``const``
rather than ``const int *``:

.. code-block:: c++

  typedef int *int_ptr;
  void f(const int_ptr ptr);

The check does not diagnose when the underlying ``typedef`` type is a pointer to
a ``const`` type or a function pointer type. This is because the ``const``
qualifier is less likely to be mistaken because it would be redundant (or
disallowed) on the underlying pointee type.