replica
/
hanchenye-llvm-project
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

[Documentation] Fix style of Clang-tidy readability-non-const-parameter. 

llvm-svn: 279541
This commit is contained in:
Eugene Zelenko 2016-08-23 17:57:24 +00:00
parent b612ac3775
commit 29da951a3a
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
clang-tools-extra/docs/clang-tidy/checks/readability-non-const-parameter.rst
View File

@ -6,16 +6,19 @@ readability-non-const-parameter
The check finds function parameters of a pointer type that could be changed to
point to a constant type instead.
When const is used properly, many mistakes can be avoided. Advantages when using
const properly:
* prevent unintentional modification of data
* get additional warnings such as using uninitialized data
* make it easier for developers to see possible side effects
When ``const`` is used properly, many mistakes can be avoided. Advantages when
using ``const`` properly:
- prevent unintentional modification of data;
- get additional warnings such as using uninitialized data;
- make it easier for developers to see possible side effects.
This check is not strict about constness, it only warns when the constness will
make the function interface safer.
.. code:: c++
.. code-block:: c++
// warning here; the declaration "const char *p" would make the function
// interface safer.
@ -41,4 +44,3 @@ make the function interface safer.
int f3(struct S *p) {
*(p->a) = 0;
}