Skip to content

Commit c5b617c

Browse files
committed
[clang-tidy][NFC] Clarify documentation for misc-definitions-in-headers
Add information about what fixes are provided by the check, and how to enable them. Issue: #55093
1 parent 511236e commit c5b617c

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

clang-tools-extra/docs/clang-tidy/checks/misc/definitions-in-headers.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,11 @@ from multiple translation units.
8888
template <class T>
8989
constexpr T pi = T(3.1415926L);
9090

91+
When :program:`clang-tidy` is invoked with the `--fix-notes` option, this check
92+
provides fixes that automatically add the ``inline`` keyword to discovered
93+
functions. Please note that the addition of the ``inline`` keyword to variables
94+
is not currently supported by this check.
95+
9196
Options
9297
-------
9398

0 commit comments

Comments
 (0)