[clang-tidy] Updates to documentation: formatting, titles, etc.

llvm-svn: 256259

diff --git a/clang-tools-extra/clang-tidy/add_new_check.py b/clang-tools-extra/clang-tidy/add_new_check.py
index 0041576..513941a 100755 (executable)
--- a/clang-tools-extra/clang-tidy/add_new_check.py
+++ b/clang-tools-extra/clang-tidy/add_new_check.py
@@ -244,7 +244,9 @@ def write_docs(module_path, module, check_name):
   print('Creating %s...' % filename)
   with open(filename, 'wb') as f:
     f.write(
-"""%(check_name_dashes)s
+""".. title:: clang-tidy - %(check_name_dashes)s
+
+%(check_name_dashes)s
 %(underline)s
 
 FIXME: Describe what patterns does the check detect and why. Give examples.

diff --git a/clang-tools-extra/docs/clang-tidy/checks/cert-setlongjmp.rst b/clang-tools-extra/docs/clang-tidy/checks/cert-setlongjmp.rst
index de3fe7f..d8be5a8 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/cert-setlongjmp.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/cert-setlongjmp.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - cert-err52-cpp
+
 cert-err52-cpp
 ==============
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/cert-static-object-exception.rst b/clang-tools-extra/docs/clang-tidy/checks/cert-static-object-exception.rst
index bb25ab0..9fec67f 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/cert-static-object-exception.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/cert-static-object-exception.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - cert-err58-cpp
+
 cert-err58-cpp
 ==============
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/cert-thrown-exception-type.rst b/clang-tools-extra/docs/clang-tidy/checks/cert-thrown-exception-type.rst
index ef05e4f..9fcb840 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/cert-thrown-exception-type.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/cert-thrown-exception-type.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - cert-err60-cpp
+
 cert-err60-cpp
 ==============
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/cert-variadic-function-def.rst b/clang-tools-extra/docs/clang-tidy/checks/cert-variadic-function-def.rst
index fcce116..5fc1fbf 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/cert-variadic-function-def.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/cert-variadic-function-def.rst
@@ -1,5 +1,7 @@
+.. title:: clang-tidy - cert-dcl50-cpp
+
 cert-dcl50-cpp
-========================
+==============
 
 This check flags all function definitions (but not declarations) of C-style
 variadic functions.

diff --git a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-bounds-array-to-pointer-decay.rst b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-bounds-array-to-pointer-decay.rst
index 93c84dc..48de244 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-bounds-array-to-pointer-decay.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-bounds-array-to-pointer-decay.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - cppcoreguidelines-pro-bounds-array-to-pointer-decay
+
 cppcoreguidelines-pro-bounds-array-to-pointer-decay
 ===================================================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-bounds-constant-array-index.rst b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-bounds-constant-array-index.rst
index 9738fc3..979f8af 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-bounds-constant-array-index.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-bounds-constant-array-index.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - cppcoreguidelines-pro-bounds-constant-array-index
+
 cppcoreguidelines-pro-bounds-constant-array-index
 =================================================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-bounds-pointer-arithmetic.rst b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-bounds-pointer-arithmetic.rst
index 60582eb..870dbf8 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-bounds-pointer-arithmetic.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-bounds-pointer-arithmetic.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - cppcoreguidelines-pro-bounds-pointer-arithmetic
+
 cppcoreguidelines-pro-bounds-pointer-arithmetic
 ===============================================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-const-cast.rst b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-const-cast.rst
index e4d6df7..a5a3840 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-const-cast.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-const-cast.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - cppcoreguidelines-pro-type-const-cast
+
 cppcoreguidelines-pro-type-const-cast
 =====================================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-cstyle-cast.rst b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-cstyle-cast.rst
index 900c1a1..55ae1bc 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-cstyle-cast.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-cstyle-cast.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - cppcoreguidelines-pro-type-cstyle-cast
+
 cppcoreguidelines-pro-type-cstyle-cast
 ======================================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-reinterpret-cast.rst b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-reinterpret-cast.rst
index 7334538..4254fb9 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-reinterpret-cast.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-reinterpret-cast.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - cppcoreguidelines-pro-type-reinterpret-cast
+
 cppcoreguidelines-pro-type-reinterpret-cast
 ===========================================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-static-cast-downcast.rst b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-static-cast-downcast.rst
index c4fdc3c..ceb66c2 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-static-cast-downcast.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-static-cast-downcast.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - cppcoreguidelines-pro-type-static-cast-downcast
+
 cppcoreguidelines-pro-type-static-cast-downcast
 ===============================================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-union-access.rst b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-union-access.rst
index 8ec2b74..0f40ff2 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-union-access.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-union-access.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - cppcoreguidelines-pro-type-union-access
+
 cppcoreguidelines-pro-type-union-access
 =======================================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-vararg.rst b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-vararg.rst
index b245c43..22b14ac 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-vararg.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines-pro-type-vararg.rst
@@ -1,12 +1,16 @@
+.. title:: clang-tidy - cppcoreguidelines-pro-type-vararg
+
 cppcoreguidelines-pro-type-vararg
-=====================================
+=================================
+
+This check flags all calls to c-style vararg functions and all use of va_arg.
 
-This check flags all calls to c-style vararg functions and all use
-of va_arg.
-To allow for SFINAE use of vararg functions, a call is not flagged if
-a literal 0 is passed as the only vararg argument.
+To allow for SFINAE use of vararg functions, a call is not flagged if a literal
+0 is passed as the only vararg argument.
 
-Passing to varargs assumes the correct type will be read. This is fragile because it cannot generally be enforced to be safe in the language and so relies on programmer discipline to get it right.
+Passing to varargs assumes the correct type will be read. This is fragile
+because it cannot generally be enforced to be safe in the language and so relies
+on programmer discipline to get it right.
 
 This rule is part of the "Type safety" profile of the C++ Core Guidelines, see
 https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#-type8-avoid-reading-from-varargs-or-passing-vararg-arguments-prefer-variadic-template-parameters-instead

diff --git a/clang-tools-extra/docs/clang-tidy/checks/google-build-explicit-make-pair.rst b/clang-tools-extra/docs/clang-tidy/checks/google-build-explicit-make-pair.rst
index 7edcb0d..8069932 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/google-build-explicit-make-pair.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/google-build-explicit-make-pair.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - google-build-explicit-make-pair
+
 google-build-explicit-make-pair
 ===============================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/google-build-namespaces.rst b/clang-tools-extra/docs/clang-tidy/checks/google-build-namespaces.rst
index ded979b..c391576 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/google-build-namespaces.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/google-build-namespaces.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - google-build-namespaces
+
 google-build-namespaces
 =======================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/google-build-using-namespace.rst b/clang-tools-extra/docs/clang-tidy/checks/google-build-using-namespace.rst
index 4e1a56e..9beb858 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/google-build-using-namespace.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/google-build-using-namespace.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - google-build-using-namespace
+
 google-build-using-namespace
 ============================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/google-explicit-constructor.rst b/clang-tools-extra/docs/clang-tidy/checks/google-explicit-constructor.rst
index e72bcbf..4d6fb10 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/google-explicit-constructor.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/google-explicit-constructor.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - google-explicit-constructor
+
 google-explicit-constructor
 ===========================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/google-global-names-in-headers.rst b/clang-tools-extra/docs/clang-tidy/checks/google-global-names-in-headers.rst
index 3b6815e..8cdd2f5 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/google-global-names-in-headers.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/google-global-names-in-headers.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - google-global-names-in-headers
+
 google-global-names-in-headers
 ==============================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/google-readability-braces-around-statements.rst b/clang-tools-extra/docs/clang-tidy/checks/google-readability-braces-around-statements.rst
index 0461d75..22dfd07 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/google-readability-braces-around-statements.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/google-readability-braces-around-statements.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - google-readability-braces-around-statements
+
 google-readability-braces-around-statements
 ===========================================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/google-readability-casting.rst b/clang-tools-extra/docs/clang-tidy/checks/google-readability-casting.rst
index 424e184..7b1e08a 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/google-readability-casting.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/google-readability-casting.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - google-readability-casting
+
 google-readability-casting
 ==========================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/google-readability-function-size.rst b/clang-tools-extra/docs/clang-tidy/checks/google-readability-function-size.rst
index d49e81e..e542e35 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/google-readability-function-size.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/google-readability-function-size.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - google-readability-function-size
+
 google-readability-function-size
 ================================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/google-readability-namespace-comments.rst b/clang-tools-extra/docs/clang-tidy/checks/google-readability-namespace-comments.rst
index cb76ea7..0bb5b20 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/google-readability-namespace-comments.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/google-readability-namespace-comments.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - google-readability-namespace-comments
+
 google-readability-namespace-comments
 =====================================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/google-readability-redundant-smartptr-get.rst b/clang-tools-extra/docs/clang-tidy/checks/google-readability-redundant-smartptr-get.rst
index 8dba233..ec28626 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/google-readability-redundant-smartptr-get.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/google-readability-redundant-smartptr-get.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - google-readability-redundant-smartptr-get
+
 google-readability-redundant-smartptr-get
 =========================================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/google-readability-todo.rst b/clang-tools-extra/docs/clang-tidy/checks/google-readability-todo.rst
index e07f1bc..16c9b16 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/google-readability-todo.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/google-readability-todo.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - google-readability-todo
+
 google-readability-todo
 =======================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/google-runtime-int.rst b/clang-tools-extra/docs/clang-tidy/checks/google-runtime-int.rst
index 3c68e0a..181d2de 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/google-runtime-int.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/google-runtime-int.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - google-runtime-int
+
 google-runtime-int
 ==================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/google-runtime-member-string-references.rst b/clang-tools-extra/docs/clang-tidy/checks/google-runtime-member-string-references.rst
index f0f1fc0..26e889b 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/google-runtime-member-string-references.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/google-runtime-member-string-references.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - google-runtime-member-string-references
+
 google-runtime-member-string-references
 =======================================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/google-runtime-memset.rst b/clang-tools-extra/docs/clang-tidy/checks/google-runtime-memset.rst
index 637cee1..63a679c 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/google-runtime-memset.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/google-runtime-memset.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - google-runtime-memset
+
 google-runtime-memset
 =====================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/google-runtime-operator.rst b/clang-tools-extra/docs/clang-tidy/checks/google-runtime-operator.rst
index acfbb43..2906f0e 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/google-runtime-operator.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/google-runtime-operator.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - google-runtime-operator
+
 google-runtime-operator
 =======================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/list.rst b/clang-tools-extra/docs/clang-tidy/checks/list.rst
index f800144..60faead 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/list.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/list.rst
@@ -1,4 +1,6 @@
-List of clang-tidy Checks
+.. title:: clang-tidy - Clang-Tidy Checks
+
+Clang-Tidy Checks
 =========================
 
 .. toctree::   

diff --git a/clang-tools-extra/docs/clang-tidy/checks/llvm-header-guard.rst b/clang-tools-extra/docs/clang-tidy/checks/llvm-header-guard.rst
index cc4f8d7..1643dfa 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/llvm-header-guard.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/llvm-header-guard.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - llvm-header-guard
+
 llvm-header-guard
 =================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/llvm-include-order.rst b/clang-tools-extra/docs/clang-tidy/checks/llvm-include-order.rst
index 562ff51..dba9837 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/llvm-include-order.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/llvm-include-order.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - llvm-include-order
+
 llvm-include-order
 ==================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/llvm-namespace-comment.rst b/clang-tools-extra/docs/clang-tidy/checks/llvm-namespace-comment.rst
index 8138da7..ac44b0c 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/llvm-namespace-comment.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/llvm-namespace-comment.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - llvm-namespace-comment
+
 llvm-namespace-comment
 ======================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/llvm-twine-local.rst b/clang-tools-extra/docs/clang-tidy/checks/llvm-twine-local.rst
index 9fb7fec..5ce0302 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/llvm-twine-local.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/llvm-twine-local.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - llvm-twine-local
+
 llvm-twine-local
 ================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-argument-comment.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-argument-comment.rst
index d3d5121..872d478 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/misc-argument-comment.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc-argument-comment.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - misc-argument-comment
+
 misc-argument-comment
 =====================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-assert-side-effect.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-assert-side-effect.rst
index dd17732..798b620 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/misc-assert-side-effect.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc-assert-side-effect.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - misc-assert-side-effect
+
 misc-assert-side-effect
 =======================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-assign-operator-signature.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-assign-operator-signature.rst
index 71d6c7b..dc34e11 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/misc-assign-operator-signature.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc-assign-operator-signature.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - misc-assign-operator-signature
+
 misc-assign-operator-signature
 ==============================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-bool-pointer-implicit-conversion.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-bool-pointer-implicit-conversion.rst
index 66fa2ad..85509c2 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/misc-bool-pointer-implicit-conversion.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc-bool-pointer-implicit-conversion.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - misc-bool-pointer-implicit-conversion
+
 misc-bool-pointer-implicit-conversion
 =====================================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-inaccurate-erase.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-inaccurate-erase.rst
index 5d8a8a2..f55bfa7 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/misc-inaccurate-erase.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc-inaccurate-erase.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - misc-inaccurate-erase
+
 misc-inaccurate-erase
 =====================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-inefficient-algorithm.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-inefficient-algorithm.rst
index 7ef0380..c61db68 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/misc-inefficient-algorithm.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc-inefficient-algorithm.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - misc-inefficient-algorithm
+
 misc-inefficient-algorithm
 ==========================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-macro-parentheses.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-macro-parentheses.rst
index b066272..6120170 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/misc-macro-parentheses.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc-macro-parentheses.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - misc-macro-parentheses
+
 misc-macro-parentheses
 ======================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-macro-repeated-side-effects.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-macro-repeated-side-effects.rst
index 0a1a8d1..7cd3781 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/misc-macro-repeated-side-effects.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc-macro-repeated-side-effects.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - misc-macro-repeated-side-effects
+
 misc-macro-repeated-side-effects
 ================================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-move-constructor-init.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-move-constructor-init.rst
index e5244e0..67c293a 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/misc-move-constructor-init.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc-move-constructor-init.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - misc-move-constructor-init
+
 misc-move-constructor-init
 ==========================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-new-delete-overloads.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-new-delete-overloads.rst
index 3813718..454af77 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/misc-new-delete-overloads.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc-new-delete-overloads.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - misc-new-delete-overloads
+
 misc-new-delete-overloads
 =========================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-noexcept-move-constructor.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-noexcept-move-constructor.rst
index 9d6438f..9d3d4f7 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/misc-noexcept-move-constructor.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc-noexcept-move-constructor.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - misc-noexcept-move-constructor
+
 misc-noexcept-move-constructor
 ==============================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-non-copyable-objects.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-non-copyable-objects.rst
index e876e8b..6d4c0fd 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/misc-non-copyable-objects.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc-non-copyable-objects.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - misc-non-copyable-objects
+
 misc-non-copyable-objects
 =========================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-sizeof-container.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-sizeof-container.rst
index b3cbb25..1d62abf 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/misc-sizeof-container.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc-sizeof-container.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - misc-sizeof-container
+
 misc-sizeof-container
 =====================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-static-assert.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-static-assert.rst
index 5ee3322..b93a8ca 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/misc-static-assert.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc-static-assert.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - misc-static-assert
+
 misc-static-assert
 ==================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-string-integer-assignment.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-string-integer-assignment.rst
index 4e2aeef..faafcd9 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/misc-string-integer-assignment.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc-string-integer-assignment.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - misc-string-integer-assignment
+
 misc-string-integer-assignment
 ==============================
 
@@ -6,11 +8,13 @@ The check finds assignments of an integer to ``std::basic_string<CharT>``
 following assignment operator of ``std::basic_string<CharT>``:
 
 .. code:: c++
+
   basic_string& operator=( CharT ch );
 
 Numeric types can be implicity casted to character types.
 
 .. code:: c++
+
   std::string s;
   int x = 5965;
   s = 6;
@@ -19,6 +23,7 @@ Numeric types can be implicity casted to character types.
 Use the appropriate conversion functions or character literals.
 
 .. code:: c++
+
   std::string s;
   int x = 5965;
   s = '6';
@@ -27,5 +32,6 @@ Use the appropriate conversion functions or character literals.
 In order to suppress false positives, use an explicit cast.
 
 .. code:: c++
+
   std::string s;
   s = static_cast<char>(6);

diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-swapped-arguments.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-swapped-arguments.rst
index 5979d13..67a604a 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/misc-swapped-arguments.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc-swapped-arguments.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - misc-swapped-arguments
+
 misc-swapped-arguments
 ======================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-throw-by-value-catch-by-reference.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-throw-by-value-catch-by-reference.rst
index 46eeb9c..2befb75 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/misc-throw-by-value-catch-by-reference.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc-throw-by-value-catch-by-reference.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - misc-throw-by-value-catch-by-reference
+
 misc-throw-by-value-catch-by-reference
 ======================================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-undelegated-constructor.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-undelegated-constructor.rst
index d4c5671..3b7fffc 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/misc-undelegated-constructor.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc-undelegated-constructor.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - misc-undelegated-constructor
+
 misc-undelegated-constructor
 ============================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-uniqueptr-reset-release.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-uniqueptr-reset-release.rst
index 92c64d7..2d4553e 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/misc-uniqueptr-reset-release.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc-uniqueptr-reset-release.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - misc-uniqueptr-reset-release
+
 misc-uniqueptr-reset-release
 ============================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-unused-alias-decls.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-unused-alias-decls.rst
index 272eb37..d0e8c71 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/misc-unused-alias-decls.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc-unused-alias-decls.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - misc-unused-alias-decls
+
 misc-unused-alias-decls
 =======================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-unused-parameters.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-unused-parameters.rst
index 36aae57..224c997 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/misc-unused-parameters.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc-unused-parameters.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - misc-unused-parameters
+
 misc-unused-parameters
 ======================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-unused-raii.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-unused-raii.rst
index 0b75970..112073d 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/misc-unused-raii.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc-unused-raii.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - misc-unused-raii
+
 misc-unused-raii
 ================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize-loop-convert.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize-loop-convert.rst
index ebe8a5c..e65c9e5 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/modernize-loop-convert.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/modernize-loop-convert.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - modernize-loop-convert
+
 modernize-loop-convert
 ======================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize-make-unique.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize-make-unique.rst
index df9d554..dcb873f 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/modernize-make-unique.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/modernize-make-unique.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - modernize-make-unique
+
 modernize-make-unique
 =====================
 
@@ -12,4 +14,3 @@ to ``std::make_unique``, introduced in C++14.
   // becomes
 
   auto my_ptr = std::make_unique<MyPair>(1, 2);
-

diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize-pass-by-value.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize-pass-by-value.rst
index f3aa5d1..6a3c900 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/modernize-pass-by-value.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/modernize-pass-by-value.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - modernize-pass-by-value
+
 modernize-pass-by-value
 =======================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize-replace-auto-ptr.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize-replace-auto-ptr.rst
index 2d22e6a..975c884 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/modernize-replace-auto-ptr.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/modernize-replace-auto-ptr.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - modernize-replace-auto-ptr
+
 modernize-replace-auto-ptr
 ==========================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize-shrink-to-fit.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize-shrink-to-fit.rst
index 1a7f06d..4d7ffaf 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/modernize-shrink-to-fit.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/modernize-shrink-to-fit.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - modernize-shrink-to-fit
+
 modernize-shrink-to-fit
 =======================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize-use-auto.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize-use-auto.rst
index 1a72657..3329e97 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/modernize-use-auto.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/modernize-use-auto.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - modernize-use-auto
+
 modernize-use-auto
 ==================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize-use-default.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize-use-default.rst
index c52cf89..157a337 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/modernize-use-default.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/modernize-use-default.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - modernize-use-default
+
 modernize-use-default
 =====================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize-use-nullptr.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize-use-nullptr.rst
index 13282a3..f0219e3 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/modernize-use-nullptr.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/modernize-use-nullptr.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - modernize-use-nullptr
+
 modernize-use-nullptr
 =====================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize-use-override.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize-use-override.rst
index 47ed011..f2c778a 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/modernize-use-override.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/modernize-use-override.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - modernize-use-override
+
 modernize-use-override
 ======================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability-braces-around-statements.rst b/clang-tools-extra/docs/clang-tidy/checks/readability-braces-around-statements.rst
index c12aed1..a1041f6 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/readability-braces-around-statements.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/readability-braces-around-statements.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - readability-braces-around-statements
+
 readability-braces-around-statements
 ====================================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability-container-size-empty.rst b/clang-tools-extra/docs/clang-tidy/checks/readability-container-size-empty.rst
index 86562df..40a878a 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/readability-container-size-empty.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/readability-container-size-empty.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - readability-container-size-empty
+
 readability-container-size-empty
 ================================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability-else-after-return.rst b/clang-tools-extra/docs/clang-tidy/checks/readability-else-after-return.rst
index 54a3f66..a8e4c46 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/readability-else-after-return.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/readability-else-after-return.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - readability-else-after-return
+
 readability-else-after-return
 =============================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability-function-size.rst b/clang-tools-extra/docs/clang-tidy/checks/readability-function-size.rst
index 7d56509..44958d7 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/readability-function-size.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/readability-function-size.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - readability-function-size
+
 readability-function-size
 =========================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability-identifier-naming.rst b/clang-tools-extra/docs/clang-tidy/checks/readability-identifier-naming.rst
index 66319a5..c03011a 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/readability-identifier-naming.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/readability-identifier-naming.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - readability-identifier-naming
+
 readability-identifier-naming
 =============================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability-implicit-bool-cast.rst b/clang-tools-extra/docs/clang-tidy/checks/readability-implicit-bool-cast.rst
index 87821ce..76c82b4 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/readability-implicit-bool-cast.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/readability-implicit-bool-cast.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - readability-implicit-bool-cast
+
 readability-implicit-bool-cast
 ==============================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability-inconsistent-declaration-parameter-name.rst b/clang-tools-extra/docs/clang-tidy/checks/readability-inconsistent-declaration-parameter-name.rst
index 8079396..aa0246c 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/readability-inconsistent-declaration-parameter-name.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/readability-inconsistent-declaration-parameter-name.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - readability-inconsistent-declaration-parameter-name
+
 readability-inconsistent-declaration-parameter-name
 ===================================================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability-named-parameter.rst b/clang-tools-extra/docs/clang-tidy/checks/readability-named-parameter.rst
index bfcabdd..97c72de 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/readability-named-parameter.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/readability-named-parameter.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - readability-named-parameter
+
 readability-named-parameter
 ===========================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability-redundant-smartptr-get.rst b/clang-tools-extra/docs/clang-tidy/checks/readability-redundant-smartptr-get.rst
index c01fbb4..7a32d42 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/readability-redundant-smartptr-get.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/readability-redundant-smartptr-get.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - readability-redundant-smartptr-get
+
 readability-redundant-smartptr-get
 ==================================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability-redundant-string-cstr.rst b/clang-tools-extra/docs/clang-tidy/checks/readability-redundant-string-cstr.rst
index 25b6b08..4614c53 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/readability-redundant-string-cstr.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/readability-redundant-string-cstr.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - readability-redundant-string-cstr
+
 readability-redundant-string-cstr
 =================================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability-simplify-boolean-expr.rst b/clang-tools-extra/docs/clang-tidy/checks/readability-simplify-boolean-expr.rst
index 0abdb04..4c3a1c8 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/readability-simplify-boolean-expr.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/readability-simplify-boolean-expr.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - readability-simplify-boolean-expr
+
 readability-simplify-boolean-expr
 =================================
 

diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability-uniqueptr-delete-release.rst b/clang-tools-extra/docs/clang-tidy/checks/readability-uniqueptr-delete-release.rst
index 6bfc692..8312235 100644 (file)
--- a/clang-tools-extra/docs/clang-tidy/checks/readability-uniqueptr-delete-release.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/readability-uniqueptr-delete-release.rst
@@ -1,3 +1,5 @@
+.. title:: clang-tidy - readability-uniqueptr-delete-release
+
 readability-uniqueptr-delete-release
 ====================================
 

diff --git a/clang-tools-extra/docs/index.rst b/clang-tools-extra/docs/index.rst
index b16933f..4ed1cf1 100644 (file)
--- a/clang-tools-extra/docs/index.rst
+++ b/clang-tools-extra/docs/index.rst
@@ -14,7 +14,7 @@ Clang's tooling API's.
 Contents
 ========
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
 
    clang-tidy/index
    modularize