Magic-Mirror/llvm-capstone
1
0
Fork 0
mirror of https://github.com/capstone-engine/llvm-capstone.git synced 2024-11-23 13:50:11 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

[clang-tidy] Document modernize-raw-string-literal check options

Browse Source 
Add missing documentation for DelimiterStem and ReplaceShorterLiterals
options.

Fixes #54662

Reviewed By: Eugene.Zelenko

Differential Revision: https://reviews.llvm.org/D153639
This commit is contained in:
Piotr Zegar 2023-06-23 16:14:14 +00:00
parent 5ddd561cb5
commit b0f6fd24dc
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

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