File: ExternalClang-TidyExamples.rst

package info (click to toggle)
llvm-toolchain-20 1%3A20.1.8-1~exp1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 2,111,388 kB
  • sloc: cpp: 7,438,767; ansic: 1,393,871; asm: 1,012,926; python: 241,728; f90: 86,635; objc: 75,411; lisp: 42,144; pascal: 17,286; sh: 10,027; ml: 5,082; perl: 4,730; awk: 3,523; makefile: 3,349; javascript: 2,251; xml: 892; fortran: 672
file content (30 lines) | stat: -rw-r--r-- 1,311 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
============================
External Clang-Tidy Examples
============================

Introduction
============

This page provides examples of what people have done with :program:`clang-tidy` that 
might serve as useful guides (or starting points) to develop your own checks. 
They may be helpful for necessary things such as how to write the `CMakeLists.txt`
for an out-of-tree plugin of :program:`clang-tidy` checks.

If you know of (or wrote!) a tool or project using :program:`clang-tidy`, please share it 
on `the Discourse forums (Clang Frontend category)
<https://discourse.llvm.org/c/clang/6>`_ for wider visibility and open a 
pull-request on `LLVM Github`_ to have it added here. Since the primary purpose of 
this page is to provide examples that can help developers, the listed projects should
have code available.

As :program:`clang-tidy` is using, for example, the AST Matchers and diagnostics of Clang,
`External Clang Examples`_ may also be useful to look at for such examples.

.. _LLVM Github: https://github.com/llvm/llvm-project
.. _External Clang Examples: https://clang.llvm.org/docs/ExternalClangExamples.html

List of projects and tools
==========================

`<https://github.com/coveooss/clang-tidy-plugin-examples>`_
    "This folder contains :program:`clang-tidy` plugins."