File: suspicious-include.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 (40 lines) | stat: -rw-r--r-- 1,453 bytes parent folder | download | duplicates (3)
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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
.. title:: clang-tidy - bugprone-suspicious-include

bugprone-suspicious-include
===========================

The check detects various cases when an include refers to what appears to be an
implementation file, which often leads to hard-to-track-down ODR violations.

Examples:

.. code-block:: c++

  #include "Dinosaur.hpp"     // OK, .hpp files tend not to have definitions.
  #include "Pterodactyl.h"    // OK, .h files tend not to have definitions.
  #include "Velociraptor.cpp" // Warning, filename is suspicious.
  #include_next <stdio.c>     // Warning, filename is suspicious.

Options
-------
.. option:: HeaderFileExtensions

   Note: this option is deprecated, it will be removed in :program:`clang-tidy`
   version 19. Please use the global configuration option
   `HeaderFileExtensions`.

   Default value: ``";h;hh;hpp;hxx"``
   A semicolon-separated list of filename extensions of header files (the
   filename extensions should not contain a "." prefix). For extension-less
   header files, use an empty string or leave an empty string between ";"
   if there are other filename extensions.

.. option:: ImplementationFileExtensions

   Note: this option is deprecated, it will be removed in :program:`clang-tidy`
   version 19. Please use the global configuration option
   `ImplementationFileExtensions`.

   Default value: ``"c;cc;cpp;cxx"``
   Likewise, a semicolon-separated list of filename extensions of
   implementation files.