diff options
author | Alexander Kornienko <alexfh@google.com> | 2015-12-22 17:36:49 +0000 |
---|---|---|
committer | Alexander Kornienko <alexfh@google.com> | 2015-12-22 17:36:49 +0000 |
commit | 785e5223d37c25ed58caa82456b6feb9828e85a1 (patch) | |
tree | 76a64d5a10e72559368d6859080d8803930a9c67 | |
parent | d167586a2849c18631c13f37bb2d6ccd14a069cb (diff) | |
download | bcm5719-llvm-785e5223d37c25ed58caa82456b6feb9828e85a1.tar.gz bcm5719-llvm-785e5223d37c25ed58caa82456b6feb9828e85a1.zip |
[clang-tidy] Updates to documentation: formatting, titles, etc.
llvm-svn: 256259
78 files changed, 170 insertions, 11 deletions
diff --git a/clang-tools-extra/clang-tidy/add_new_check.py b/clang-tools-extra/clang-tidy/add_new_check.py index 0041576e482..513941ad777 100755 --- 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 de3fe7f23c5..d8be5a8dd9a 100644 --- 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 bb25ab06454..9fec67f0ec4 100644 --- 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 ef05e4f9f1b..9fcb840fc06 100644 --- 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 fcce116027c..5fc1fbfbb58 100644 --- 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 93c84dc7e3e..48de24473e8 100644 --- 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 9738fc3cf16..979f8af4fb1 100644 --- 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 60582eb73eb..870dbf87ee0 100644 --- 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 e4d6df7fbcd..a5a38406461 100644 --- 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 900c1a1b404..55ae1bc5925 100644 --- 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 73345387e74..4254fb9e2a4 100644 --- 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 c4fdc3cce70..ceb66c20c55 100644 --- 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 8ec2b74c4cf..0f40ff202d7 100644 --- 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 b245c43b4cf..22b14ace531 100644 --- 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 7edcb0d7897..8069932e0f1 100644 --- 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 ded979bad6d..c39157624f1 100644 --- 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 4e1a56e9281..9beb858df14 100644 --- 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 e72bcbf07dc..4d6fb1040e2 100644 --- 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 3b6815e13fc..8cdd2f5b718 100644 --- 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 0461d75e499..22dfd07d95f 100644 --- 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 424e184a01e..7b1e08aaba5 100644 --- 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 d49e81e5e9d..e542e356ce7 100644 --- 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 cb76ea7e1ac..0bb5b20cb24 100644 --- 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 8dba2338477..ec286266697 100644 --- 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 e07f1bc1d83..16c9b165d4d 100644 --- 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 3c68e0a8300..181d2dec000 100644 --- 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 f0f1fc09b02..26e889bb2c7 100644 --- 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 637cee1550a..63a679c1fb5 100644 --- 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 acfbb43af75..2906f0e3c6a 100644 --- 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 f8001440e73..60faead09ab 100644 --- 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 cc4f8d7b231..1643dfaba50 100644 --- 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 562ff515529..dba98376c94 100644 --- 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 8138da71acc..ac44b0ca2bc 100644 --- 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 9fb7fec1300..5ce0302b5d8 100644 --- 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 d3d51218475..872d4783c4b 100644 --- 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 dd17732a4cf..798b62044ac 100644 --- 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 71d6c7b6d22..dc34e1181a1 100644 --- 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 66fa2ad9a58..85509c233b8 100644 --- 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 5d8a8a2378b..f55bfa73b9f 100644 --- 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 7ef038068c4..c61db68e5a6 100644 --- 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 b066272c448..6120170be94 100644 --- 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 0a1a8d1e978..7cd3781eec8 100644 --- 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 e5244e0467f..67c293a7447 100644 --- 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 381371881ea..454af77a9e1 100644 --- 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 9d6438fbca8..9d3d4f79a6a 100644 --- 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 e876e8b74e1..6d4c0fd5956 100644 --- 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 b3cbb25deb0..1d62abff2f3 100644 --- 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 5ee3322eebc..b93a8caf660 100644 --- 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 4e2aeef2183..faafcd99158 100644 --- 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 5979d13711e..67a604a130a 100644 --- 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 46eeb9c30f2..2befb75b0fd 100644 --- 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 d4c567184e5..3b7fffcd21f 100644 --- 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 92c64d763b3..2d4553e705c 100644 --- 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 272eb3776ee..d0e8c7188a3 100644 --- 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 36aae57fd36..224c997dfb6 100644 --- 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 0b759705f2d..112073dcbd3 100644 --- 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 ebe8a5cc5ee..e65c9e59bcd 100644 --- 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 df9d5545cea..dcb873f0096 100644 --- 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 f3aa5d160d9..6a3c9000404 100644 --- 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 2d22e6a3a9e..975c884e0b6 100644 --- 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 1a7f06d2d33..4d7ffafe2a9 100644 --- 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 1a72657c4aa..3329e9773f8 100644 --- 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 c52cf89b918..157a337c97b 100644 --- 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 13282a3c943..f0219e3abea 100644 --- 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 47ed011ef32..f2c778aaae1 100644 --- 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 c12aed1765c..a1041f6ea9c 100644 --- 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 86562df6a68..40a878a26b3 100644 --- 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 54a3f6642b4..a8e4c4604a9 100644 --- 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 7d5650903d8..44958d71acb 100644 --- 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 66319a593c9..c03011adb75 100644 --- 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 87821ceab79..76c82b41ec4 100644 --- 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 8079396546b..aa0246c1dec 100644 --- 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 bfcabdd9dcb..97c72de91c8 100644 --- 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 c01fbb4bc6a..7a32d425f91 100644 --- 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 25b6b086590..4614c53a227 100644 --- 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 0abdb040052..4c3a1c8f8ce 100644 --- 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 6bfc692a3bd..83122356d46 100644 --- 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 b16933f558d..4ed1cf1dcd5 100644 --- 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 |