Skip to content

Commit b0f6fd2

Browse files
committed
[clang-tidy] Document modernize-raw-string-literal check options
Add missing documentation for DelimiterStem and ReplaceShorterLiterals options. Fixes #54662 Reviewed By: Eugene.Zelenko Differential Revision: https://reviews.llvm.org/D153639
1 parent 5ddd561 commit b0f6fd2

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

clang-tools-extra/docs/clang-tidy/checks/modernize/raw-string-literal.rst

+13-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ with raw string literals.
88

99
Example:
1010

11-
.. code-blocK:: c++
11+
.. code-block:: c++
1212

1313
const char *const Quotes{"embedded \"quotes\""};
1414
const char *const Paragraph{"Line one.\nLine two.\nLine three.\n"};
@@ -44,3 +44,15 @@ string literals are left unchanged.
4444
An escaped horizontal tab, form feed, or vertical tab prevents the string
4545
literal from being converted. The presence of a horizontal tab, form feed or
4646
vertical tab in source code is not visually obvious.
47+
48+
.. option:: DelimiterStem
49+
50+
Custom delimiter to escape characters in raw string literals. It is used in
51+
the following construction: ``R"stem_delimiter(contents)stem_delimiter"``.
52+
The default value is `lit`.
53+
54+
.. option:: ReplaceShorterLiterals
55+
56+
Controls replacing shorter non-raw string literals with longer raw string
57+
literals. Setting this option to `true` enables the replacement.
58+
The default value is `false` (shorter literals are not replaced).

0 commit comments

Comments
 (0)