wangtao
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[clang-tidy] updated misc-sizeof-container docs. 

llvm-svn: 247580
This commit is contained in:
Alexander Kornienko 2015-09-14 16:56:57 +00:00
parent e0f603fad5
commit 64aa388efa
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
clang-tools-extra/docs/clang-tidy/checks/misc-sizeof-container.rst
View File

@ -4,7 +4,9 @@ misc-sizeof-container
The check finds usages of ``sizeof`` on expressions of STL container types. Most
likely the user wanted to use ``.size()`` instead.
Currently only ``std::string`` and ``std::vector<T>`` are supported.
All class/struct types declared in namespace ``std::`` having a const ``size()``
method are considered containers, with the exception of ``std::bitset`` and
``std::array``.
Examples:
@ -12,9 +14,12 @@ Examples:
std::string s;
int a = 47 + sizeof(s); // warning: sizeof() doesn't return the size of the container. Did you mean .size()?
// The suggested fix is: int a = 47 + s.size();
int b = sizeof(std::string); // no warning, probably intended.
std::string array_of_strings[10];
int c = sizeof(array_of_strings) / sizeof(array_of_strings[0]); // no warning, definitely intended.
std::array<int, 3> std_array;
int d = sizeof(std_array); // no warning, probably intended.