File tree Expand file tree Collapse file tree 2 files changed +31
-0
lines changed Expand file tree Collapse file tree 2 files changed +31
-0
lines changed Original file line number Diff line number Diff line change 1+ ============================
2+ External Clang-Tidy Examples
3+ ============================
4+
5+ Introduction
6+ ============
7+
8+ This page provides examples of what people have done with :program: `clang-tidy ` that
9+ might serve as useful guides (or starting points) to develop your own checks.
10+ They may be helpful for necessary things such as how to write the `CMakeLists.txt `
11+ for an out-of-tree plugin of :program: `clang-tidy ` checks.
12+
13+ If you know of (or wrote!) a tool or project using :program: `clang-tidy `, please share it
14+ on `the Discourse forums (Clang Frontend category)
15+ <https://discourse.llvm.org/c/clang/6> `_ for wider visibility and open a
16+ pull-request on `LLVM Github `_ to have it added here. Since the primary purpose of
17+ this page is to provide examples that can help developers, the listed projects should
18+ have code available.
19+
20+ As :program: `clang-tidy ` is using, for example, the AST Matchers and diagnostics of Clang,
21+ `External Clang Examples `_ may also be useful to look at for such examples.
22+
23+ .. _LLVM Github : https://github.com/llvm/llvm-project
24+ .. _External Clang Examples : https://clang.llvm.org/docs/ExternalClangExamples.html
25+
26+ List of projects and tools
27+ ==========================
28+
29+ `<https://github.com/coveooss/clang-tidy-plugin-examples >`_
30+ "This folder contains :program: `clang-tidy ` plugins."
Original file line number Diff line number Diff line change @@ -12,6 +12,7 @@ See also:
1212 The list of clang-tidy checks <checks/list >
1313 Clang-tidy IDE/Editor Integrations <Integrations >
1414 Getting Involved <Contributing >
15+ External Clang-Tidy Examples <ExternalClang-TidyExamples >
1516
1617:program: `clang-tidy ` is a clang-based C++ "linter" tool. Its purpose is to
1718provide an extensible framework for diagnosing and fixing typical programming
You can’t perform that action at this time.
0 commit comments