[PATCH] D20463: [clang-tidy] Add more descriptive comments and examples in misc-definitions-in-headers check.

[Alexander Kornienko via cfe-commits]

alexfh requested changes to this revision.
This revision now requires changes to proceed.

================
Comment at: docs/clang-tidy/checks/misc-definitions-in-headers.rst:8
@@ +7,3 @@
+If these headers are included from multiple translation units, there will be
+redefinition linker errors.
+
----------------
It wouldn't be a large problem, if linker was always able to detect ODR violations. However, there are cases, where it can't do so. You can still append "in case these headers are included from multiple translation units." to the previous sentence.

================
Comment at: docs/clang-tidy/checks/misc-definitions-in-headers.rst:35
@@ -27,3 +34,3 @@
 
-   // OK: inline function definition.
+   // OK: inline function definition is allowed to be multiply defined.
    inline int e() {
----------------
s/multiply defined/defined multiple times/

================
Comment at: docs/clang-tidy/checks/misc-definitions-in-headers.rst:47
@@ +46,3 @@
+
+   // Warning: not a inline member function definition.
+   int A::f2() { return 1; }
----------------
s/a inline/an inline/

================
Comment at: docs/clang-tidy/checks/misc-definitions-in-headers.rst:53
@@ +52,3 @@
+
+   // OK: funtion template is allowed.
+   template<typename T>
----------------
s/funtion/function/

================
Comment at: docs/clang-tidy/checks/misc-definitions-in-headers.rst:60
@@ +59,3 @@
+
+   // Warning: full function template specialization is not allowed.
+   template <>
----------------
`full specialization of a function template ...`


http://reviews.llvm.org/D20463