Skip to content

Commit b9b424a

Browse files
committed
Update unintended-char-ostream-output.rst
1 parent badfb83 commit b9b424a

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

clang-tools-extra/docs/clang-tidy/checks/bugprone/unintended-char-ostream-output.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,12 @@ Options
4444

4545
.. option:: AllowedTypes
4646

47-
A semicolon-separated list of type names that will be treated as ``char``
48-
type. It only contains the non canonical type names without the alias of type
49-
names. Explicit casting to these types or use the variable defined with these
50-
types will be ignored.
47+
A semicolon-separated list of type names that will be treated like the ``char``
48+
type: the check will not report variables declared with with these types or
49+
explicit cast expressions to these types. Note that this distinguishes type
50+
aliases from the original type, so specifying e.g. ``unsigned char`` here
51+
will not suppress reports about ``uint8_t`` even if it is defined as a
52+
``typedef`` alias for ``unsigned char``.
5153
Default is `unsigned char;signed char`.
5254

5355
.. option:: CastTypeName

0 commit comments

Comments
 (0)