diff options
Diffstat (limited to 'clang-tools-extra/docs/clang-tidy')
4 files changed, 13 insertions, 11 deletions
diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-dangling-handle.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-dangling-handle.rst index 06601c68520..03c04e3b604 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/misc-dangling-handle.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/misc-dangling-handle.rst @@ -4,12 +4,12 @@ misc-dangling-handle ==================== Detect dangling references in value handlers like -`std::experimental::string_view`. +``std::experimental::string_view``. These dangling references can come from constructing handles from temporary values, where the temporary is destroyed soon after the handle is created. -By default only `std::experimental::basic_string_view` is considered. -This list can be modified by passing a ; separated list of class names using +By default only ``std::experimental::basic_string_view`` is considered. +This list can be modified by passing a `;` separated list of class names using the HandleClasses option. Examples: diff --git a/clang-tools-extra/docs/clang-tidy/checks/performance-faster-string-find.rst b/clang-tools-extra/docs/clang-tidy/checks/performance-faster-string-find.rst index 147f0c3815a..018fa91d296 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/performance-faster-string-find.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/performance-faster-string-find.rst @@ -3,11 +3,11 @@ performance-faster-string-find ============================== -Optimize calls to std::string::find() and friends when the needle passed is +Optimize calls to ``std::string::find()`` and friends when the needle passed is a single character string literal. The character literal overload is more efficient. -By default only `std::basic_string` is considered. This list can be modified by +By default only ``std::basic_string`` is considered. This list can be modified by passing a `;` separated list of class names using the `StringLikeClasses` option. The methods to consired are fixed, though. diff --git a/clang-tools-extra/docs/clang-tidy/checks/performance-implicit-cast-in-loop.rst b/clang-tools-extra/docs/clang-tidy/checks/performance-implicit-cast-in-loop.rst index f7e3cdcc6e7..4a3c63d860a 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/performance-implicit-cast-in-loop.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/performance-implicit-cast-in-loop.rst @@ -1,8 +1,9 @@ performance-implicit-cast-in-loop ================================= -This warning appears in range-based loop with loop variable of const ref type -where the type of the variable does not match the one returned by the iterator. +This warning appears in a range-based loop with a loop variable of const ref +type where the type of the variable does not match the one returned by the +iterator. This means that an implicit cast has been added, which can for example result in expensive deep copies. diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability-redundant-control-flow.rst b/clang-tools-extra/docs/clang-tidy/checks/readability-redundant-control-flow.rst index ab1b03bfaa5..64f561c6e53 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/readability-redundant-control-flow.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/readability-redundant-control-flow.rst @@ -3,11 +3,12 @@ readability-redundant-control-flow ================================== -This check looks for procedures (functions returning no value) with `return` -statements at the end of the function. Such `return` statements are redundant. +This check looks for procedures (functions returning no value) with ``return`` +statements at the end of the function. Such ``return`` statements are +redundant. -Loop statements (`for`, `while`, `do while`) are checked for redundant -`continue` statements at the end of the loop body. +Loop statements (``for``, ``while``, ``do while``) are checked for redundant +``continue`` statements at the end of the loop body. Examples: |
