[clang-tidy] Fix documentation of misc-suspicious-missing-comma

Summary:
The clang-tidy documentation generation was broken since commit : http://reviews.llvm.org/D18457

I ran locally the documentation generation and I fixed errors related to that specific check.

Reviewers: alexfh

Subscribers: cfe-commits

Differential Revision: http://reviews.llvm.org/D18764

llvm-svn: 265375
This commit is contained in:
Etienne Bergeron 2016-04-05 01:41:02 +00:00
parent 5cea969dca
commit 009ec085db
1 changed files with 12 additions and 3 deletions

View File

@ -7,14 +7,19 @@ String literals placed side-by-side are concatenated at translation phase 6
(after the preprocessor). This feature is used to represent long string
literal on multiple lines.
For instance, these declarations are equivalent:
For instance, the following declarations are equivalent:
.. code:: c++
const char* A[] = "This is a test";
const char* B[] = "This" " is a "
"test";
const char* B[] = "This" " is a " "test";
A common mistake done by programmers is to forget a comma between two string
literals in an array initializer list.
.. code:: c++
const char* Test[] = {
"line 1",
"line 2" // Missing comma!
@ -23,13 +28,17 @@ literals in an array initializer list.
"line 5"
};
The array contains the string "line 2line3" at offset 1 (i.e. Test[1]). Clang
won't generate warnings at compile time.
This checker may warn incorrectly on cases like:
.. code:: c++
const char* SupportedFormat[] = {
"Error %s",
"Code " PRIu64, // May warn here.
"Warning %s",
};