[clang-tools-extra] c5b617c - [clang-tidy][NFC] Clarify documentation for misc-definitions-in-headers

[Piotr Zegar via cfe-commits]

Author: Piotr Zegar
Date: 2023-10-16T20:50:38Z
New Revision: c5b617c5e53d7af81c621d200e2cd03324538541

URL: https://github.com/llvm/llvm-project/commit/c5b617c5e53d7af81c621d200e2cd03324538541
DIFF: https://github.com/llvm/llvm-project/commit/c5b617c5e53d7af81c621d200e2cd03324538541.diff

LOG: [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

Added: 
    

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

Removed: 
    


################################################################################
diff  --git a/clang-tools-extra/docs/clang-tidy/checks/misc/definitions-in-headers.rst b/clang-tools-extra/docs/clang-tidy/checks/misc/definitions-in-headers.rst
index 08aa9d884c239ff..9c90bf10217f4ca 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/misc/definitions-in-headers.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc/definitions-in-headers.rst
@@ -88,6 +88,11 @@ from multiple translation units.
    template <class T>
    constexpr T pi = T(3.1415926L);
 
+When :program:`clang-tidy` is invoked with the `--fix-notes` option, this check
+provides fixes that automatically add the ``inline`` keyword to discovered
+functions. Please note that the addition of the ``inline`` keyword to variables
+is not currently supported by this check.
+
 Options
 -------