Author: eugenezelenko
Date: Tue Jun 7 13:29:15 2016
New Revision: 272038
URL: http://llvm.org/viewvc/llvm-project?rev=272038&view=rev
Log:
[Clang-tidy] Documentation style consistency.
Modified:
clang-tools-extra/trunk/docs/ReleaseNotes.rst
clang-tools-extra/trunk/docs/clang-tidy/checks/misc-misplaced-const.rst
Modified: clang-tools-extra/trunk/docs/ReleaseNotes.rst
URL:
http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/ReleaseNotes.rst?rev=272038&r1=272037&r2=272038&view=diff
==============================================================================
--- clang-tools-extra/trunk/docs/ReleaseNotes.rst (original)
+++ clang-tools-extra/trunk/docs/ReleaseNotes.rst Tue Jun 7 13:29:15 2016
@@ -126,8 +126,8 @@ identified. The improvements since the
- 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
Modified:
clang-tools-extra/trunk/docs/clang-tidy/checks/misc-misplaced-const.rst
URL:
http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/clang-tidy/checks/misc-misplaced-const.rst?rev=272038&r1=272037&r2=272038&view=diff
==============================================================================
--- clang-tools-extra/trunk/docs/clang-tidy/checks/misc-misplaced-const.rst
(original)
+++ clang-tools-extra/trunk/docs/clang-tidy/checks/misc-misplaced-const.rst Tue
Jun 7 13:29:15 2016
@@ -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.
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
