summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEugene Zelenko <eugene.zelenko@gmail.com>2016-06-07 18:29:15 +0000
committerEugene Zelenko <eugene.zelenko@gmail.com>2016-06-07 18:29:15 +0000
commit04c14db108e5e4b15f1151c11946bb5a18121c28 (patch)
tree985f32d29a80e904ae06c6553341ca70dfca3430
parent86f8d33442725c91c23a9ee1876fa784fa6038ed (diff)
downloadbcm5719-llvm-04c14db108e5e4b15f1151c11946bb5a18121c28.tar.gz
bcm5719-llvm-04c14db108e5e4b15f1151c11946bb5a18121c28.zip
[Clang-tidy] Documentation style consistency.
llvm-svn: 272038
-rw-r--r--clang-tools-extra/docs/ReleaseNotes.rst4
-rw-r--r--clang-tools-extra/docs/clang-tidy/checks/misc-misplaced-const.rst19
2 files changed, 12 insertions, 11 deletions
diff --git a/clang-tools-extra/docs/ReleaseNotes.rst b/clang-tools-extra/docs/ReleaseNotes.rst
index 37b20598c8c..26f2e4fe1e3 100644
--- a/clang-tools-extra/docs/ReleaseNotes.rst
+++ b/clang-tools-extra/docs/ReleaseNotes.rst
@@ -126,8 +126,8 @@ identified. The improvements since the 3.8 release include:
- New `misc-misplaced-const
<http://clang.llvm.org/extra/clang-tidy/checks/misc-misplaced-const.html>`_ check
- Checks if a const-qualifier is applied to a typedef to pointer type instead of
- the underlying pointee type.
+ Checks if a ``const`` qualifier is applied to a ``typedef`` to pointer type
+ instead of the underlying pointee type.
- New `misc-misplaced-widening-cast
<http://clang.llvm.org/extra/clang-tidy/checks/misc-misplaced-widening-cast.html>`_ check
diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-misplaced-const.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-misplaced-const.rst
index c51a82b64bd..a0471e2e0a6 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/misc-misplaced-const.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc-misplaced-const.rst
@@ -3,19 +3,20 @@
misc-misplaced-const
====================
-This check diagnoses when a const qualifier is applied to a typedef to a pointer
-type rather than to the pointee, because such constructs are often misleading to
-developers because the const applies to the pointer rather than the pointee.
+This check diagnoses when a ``const`` qualifier is applied to a ``typedef`` to a
+pointer type rather than to the pointee, because such constructs are often
+misleading to developers because the ``const`` applies to the pointer rather
+than the pointee.
-For instance, in the following code, the resulting type is `int *` const rather
-than `const int *`:
+For instance, in the following code, the resulting type is ``int *`` ``const``
+rather than ``const int *``:
.. code:: c++
typedef int *int_ptr;
void f(const int_ptr ptr);
-The check does not diagnose when the underlying typedef type is a pointer to a
-const type or a function pointer type. This is because the const qualifier is
-less likely to be mistaken because it would be redundant (or disallowed) on the
-underlying pointee type.
+The check does not diagnose when the underlying ``typedef`` type is a pointer to
+a ``const`` type or a function pointer type. This is because the ``const``
+qualifier is less likely to be mistaken because it would be redundant (or
+disallowed) on the underlying pointee type.
OpenPOWER on IntegriCloud