summaryrefslogtreecommitdiffstats
path: root/clang-tools-extra/docs/clang-tidy
diff options
context:
space:
mode:
Diffstat (limited to 'clang-tools-extra/docs/clang-tidy')
-rw-r--r--clang-tools-extra/docs/clang-tidy/checks/list.rst1
-rw-r--r--clang-tools-extra/docs/clang-tidy/checks/misc-virtual-near-miss.rst17
2 files changed, 18 insertions, 0 deletions
diff --git a/clang-tools-extra/docs/clang-tidy/checks/list.rst b/clang-tools-extra/docs/clang-tidy/checks/list.rst
index bee3eef6e4a..011e58603e1 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/list.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/list.rst
@@ -65,6 +65,7 @@ Clang-Tidy Checks
misc-unused-alias-decls
misc-unused-parameters
misc-unused-raii
+ misc-virtual-near-miss
modernize-loop-convert
modernize-make-unique
modernize-pass-by-value
diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-virtual-near-miss.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-virtual-near-miss.rst
new file mode 100644
index 00000000000..dd40ce3555e
--- /dev/null
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc-virtual-near-miss.rst
@@ -0,0 +1,17 @@
+misc-virtual-near-miss
+======================
+
+Warn if a function is a near miss (ie. the name is very similar and the function signiture is the same) to a virtual function from a base class.
+
+Example:
+
+.. code-block:: c++
+
+ struct Base {
+ virtual void func();
+ };
+
+ struct Derived : Base {
+ virtual funk();
+ // warning: Do you want to override 'func'?
+ };
OpenPOWER on IntegriCloud