summaryrefslogtreecommitdiffstats
path: root/clang-tools-extra/docs/clang-tidy/checks/readability-avoid-const-params-in-decls.rst
diff options
context:
space:
mode:
Diffstat (limited to 'clang-tools-extra/docs/clang-tidy/checks/readability-avoid-const-params-in-decls.rst')
-rw-r--r--clang-tools-extra/docs/clang-tidy/checks/readability-avoid-const-params-in-decls.rst10
1 files changed, 5 insertions, 5 deletions
diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability-avoid-const-params-in-decls.rst b/clang-tools-extra/docs/clang-tidy/checks/readability-avoid-const-params-in-decls.rst
index e9ece6591c4..3aea5d0c075 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/readability-avoid-const-params-in-decls.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/readability-avoid-const-params-in-decls.rst
@@ -3,15 +3,15 @@
readability-avoid-const-params-in-decls
=======================================
-Checks whether a function declaration has parameters that are top level const.
+Checks whether a function declaration has parameters that are top level
+``const``.
-`const` values in declarations do not affect the signature of a function, so
-they should not be put there. For example:
+``const`` values in declarations do not affect the signature of a function, so
+they should not be put there.
Examples:
-.. code:: c++
+.. code-block:: c++
void f(const string); // Bad: const is top level.
void f(const string&); // Good: const is not top level.
-
OpenPOWER on IntegriCloud