File: use-override.rst

package info (click to toggle)
llvm-toolchain-15 1%3A15.0.6-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,554,644 kB
  • sloc: cpp: 5,922,452; ansic: 1,012,136; asm: 674,362; python: 191,568; objc: 73,855; f90: 42,327; lisp: 31,913; pascal: 11,973; javascript: 10,144; sh: 9,421; perl: 7,447; ml: 5,527; awk: 3,523; makefile: 2,520; xml: 885; cs: 573; fortran: 567
file content (52 lines) | stat: -rw-r--r-- 1,872 bytes parent folder | download | duplicates (9)
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
41
42
43
44
45
46
47
48
49
50
51
52
.. title:: clang-tidy - modernize-use-override

modernize-use-override
======================

Adds ``override`` (introduced in C++11) to overridden virtual functions and
removes ``virtual`` from those functions as it is not required.

``virtual`` on non base class implementations was used to help indicate to the
user that a function was virtual. C++ compilers did not use the presence of
this to signify an overridden function.

In C++ 11 ``override`` and ``final`` keywords were introduced to allow
overridden functions to be marked appropriately. Their presence allows
compilers to verify that an overridden function correctly overrides a base
class implementation.

This can be useful as compilers can generate a compile time error when:

 - The base class implementation function signature changes.
 - The user has not created the override with the correct signature.

Options
-------

.. option:: IgnoreDestructors

   If set to `true`, this check will not diagnose destructors. Default is `false`.

.. option:: AllowOverrideAndFinal

   If set to `true`, this check will not diagnose ``override`` as redundant
   with ``final``. This is useful when code will be compiled by a compiler with
   warning/error checking flags requiring ``override`` explicitly on overridden
   members, such as ``gcc -Wsuggest-override``/``gcc -Werror=suggest-override``.
   Default is `false`.

.. option:: OverrideSpelling

   Specifies a macro to use instead of ``override``. This is useful when
   maintaining source code that also needs to compile with a pre-C++11
   compiler.

.. option:: FinalSpelling

   Specifies a macro to use instead of ``final``. This is useful when
   maintaining source code that also needs to compile with a pre-C++11
   compiler.

.. note::

   For more information on the use of ``override`` see https://en.cppreference.com/w/cpp/language/override