summaryrefslogtreecommitdiffstats
path: root/clang-tools-extra/docs/clang-tidy/checks/llvm-header-guard.rst
diff options
context:
space:
mode:
Diffstat (limited to 'clang-tools-extra/docs/clang-tidy/checks/llvm-header-guard.rst')
-rw-r--r--clang-tools-extra/docs/clang-tidy/checks/llvm-header-guard.rst9
1 files changed, 8 insertions, 1 deletions
diff --git a/clang-tools-extra/docs/clang-tidy/checks/llvm-header-guard.rst b/clang-tools-extra/docs/clang-tidy/checks/llvm-header-guard.rst
index 1643dfaba50..dacaeefdf2c 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/llvm-header-guard.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/llvm-header-guard.rst
@@ -3,4 +3,11 @@
llvm-header-guard
=================
-TODO: add docs
+Finds and fixes header guards that do not adhere to LLVM style.
+
+Options
+-------
+
+.. option:: HeaderFileExtensions
+
+ A comma-separated list of filename extensions of header files (The filename extension should not contain "." prefix). Default value is ",h,hh,hpp,hxx". For extension-less header files, using an empty string or leaving an empty string between "," if there are other filename extensions.
OpenPOWER on IntegriCloud