summaryrefslogtreecommitdiffstats
path: root/clang-tools-extra/docs/clang-tidy/checks/readability-redundant-string-init.rst
diff options
context:
space:
mode:
Diffstat (limited to 'clang-tools-extra/docs/clang-tidy/checks/readability-redundant-string-init.rst')
-rw-r--r--clang-tools-extra/docs/clang-tidy/checks/readability-redundant-string-init.rst15
1 files changed, 14 insertions, 1 deletions
diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability-redundant-string-init.rst b/clang-tools-extra/docs/clang-tidy/checks/readability-redundant-string-init.rst
index e4136ea4234..c4556887f89 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/readability-redundant-string-init.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/readability-redundant-string-init.rst
@@ -5,7 +5,8 @@ readability-redundant-string-init
Finds unnecessary string initializations.
-Examples:
+Examples
+--------
.. code-block:: c++
@@ -17,3 +18,15 @@ Examples:
std::string a;
std::string b;
+
+Options
+-------
+
+.. option:: StringNames
+
+ Default is `::std::basic_string`.
+
+ Semicolon-delimited list of class names to apply this check to.
+ By default `::std::basic_string` applies to ``std::string`` and
+ ``std::wstring``. Set to e.g. `::std::basic_string;llvm::StringRef;QString`
+ to perform this check on custom classes.
OpenPOWER on IntegriCloud