diff options
Diffstat (limited to 'clang-tools-extra/docs/clang-tidy')
| -rw-r--r-- | clang-tools-extra/docs/clang-tidy/checks/list.rst | 1 | ||||
| -rw-r--r-- | clang-tools-extra/docs/clang-tidy/checks/readability-simplify-subscript-expr.rst | 23 |
2 files changed, 24 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 efc80a2db9b..c90902a3511 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/list.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/list.rst @@ -227,6 +227,7 @@ Clang-Tidy Checks readability-redundant-string-cstr readability-redundant-string-init readability-simplify-boolean-expr + readability-simplify-subscript-expr readability-static-accessed-through-instance readability-static-definition-in-anonymous-namespace readability-string-compare diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability-simplify-subscript-expr.rst b/clang-tools-extra/docs/clang-tidy/checks/readability-simplify-subscript-expr.rst new file mode 100644 index 00000000000..f3f44bedcf7 --- /dev/null +++ b/clang-tools-extra/docs/clang-tidy/checks/readability-simplify-subscript-expr.rst @@ -0,0 +1,23 @@ +.. title:: clang-tidy - readability-simplify-subscript-expr + +readability-simplify-subscript-expr +=================================== + +This check simplifies subscript expressions. Currently this covers calling +``.data()`` and immediately doing an array subscript operation to obtain a +single element, in which case simply calling ``operator[]`` suffice. + +Examples: + +.. code-block:: c++ + + std::string s = ...; + char c = s.data()[i]; // char c = s[i]; + +Options +------- + +.. option:: Types + + The list of type(s) that triggers this check. Default is + `::std::basic_string;::std::basic_string_view;::std::vector;::std::array` |
