Skip to content

Commit 44abe93

Browse files
committed
[clang-tidy] fixed styles of default parameters in docs
1 parent 4533c32 commit 44abe93

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

clang-tools-extra/docs/clang-tidy/checks/misc/const-correctness.rst

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,10 @@ This limitation affects the capability to add ``const`` to methods which is not
8080
Options
8181
-------
8282

83-
.. option:: AnalyzeValues (default = true)
83+
.. option:: AnalyzeValues
8484

85-
Enable or disable the analysis of ordinary value variables, like ``int i = 42;``
85+
Enable or disable the analysis of ordinary value variables, like
86+
``int i = 42;``. Default is `true`.
8687

8788
.. code-block:: c++
8889

@@ -96,9 +97,10 @@ Options
9697
// No warning
9798
int const a[] = {42, 42, 42};
9899

99-
.. option:: AnalyzeReferences (default = true)
100+
.. option:: AnalyzeReferences
100101

101-
Enable or disable the analysis of reference variables, like ``int &ref = i;``
102+
Enable or disable the analysis of reference variables, like
103+
``int &ref = i;``. Default is `true`.
102104

103105
.. code-block:: c++
104106

@@ -108,11 +110,11 @@ Options
108110
// No warning
109111
int const& ref = i;
110112

111-
.. option:: WarnPointersAsValues (default = false)
113+
.. option:: WarnPointersAsValues
112114

113115
This option enables the suggestion for ``const`` of the pointer itself.
114116
Pointer values have two possibilities to be ``const``, the pointer
115-
and the value pointing to.
117+
and the value pointing to. Default is `false`.
116118

117119
.. code-block:: c++
118120

@@ -123,9 +125,10 @@ Options
123125
// No warning
124126
const int *const pointer_variable = &value;
125127
126-
.. option:: TransformValues (default = true)
128+
.. option:: TransformValues
127129

128-
Provides fixit-hints for value types that automatically add ``const`` if its a single declaration.
130+
Provides fixit-hints for value types that automatically add ``const`` if
131+
its a single declaration. Default is `true`.
129132

130133
.. code-block:: c++
131134

@@ -143,10 +146,10 @@ Options
143146
int result = value * 3;
144147
result -= 10;
145148

146-
.. option:: TransformReferences (default = true)
149+
.. option:: TransformReferences
147150

148-
Provides fixit-hints for reference types that automatically add ``const`` if its a single
149-
declaration.
151+
Provides fixit-hints for reference types that automatically add ``const`` if
152+
its a single declaration. Default is `true`.
150153

151154
.. code-block:: c++
152155

@@ -163,10 +166,10 @@ Options
163166
int result = ref_value * 3;
164167
result -= 10;
165168

166-
.. option:: TransformPointersAsValues (default = false)
169+
.. option:: TransformPointersAsValues
167170

168-
Provides fixit-hints for pointers if their pointee is not changed. This does not analyze if the
169-
value-pointed-to is unchanged!
171+
Provides fixit-hints for pointers if their pointee is not changed. This does
172+
not analyze if the value-pointed-to is unchanged! Default is `false`.
170173

171174
Requires 'WarnPointersAsValues' to be 'true'.
172175

0 commit comments

Comments
 (0)