Skip to content

Add clang-tidy external examples #106675

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
23 changes: 12 additions & 11 deletions clang-tools-extra/docs/clang-tidy/ExternalClang-TidyExamples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,22 @@ External Clang-Tidy Examples
Introduction
============

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

If you know of (or wrote!) a tool or project using clang-tidy, please post on
`the Discourse forums (Clang Frontend category)
<https://discourse.llvm.org/c/clang/6>`_ to have it added.
(or if you are already a clang-tidy contributor, feel free to directly commit
additions). Since the primary purpose of this page is to provide examples
that can help developers, generally they must have code available.
If you know of (or wrote!) a tool or project using 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, generally they must have
code available.

As clang-tidy shares C++ AST Matchers with Clang diagnostics, `External Clang Examples`_
may also be useful to look at.
As `clang-tidy` shares C++ AST Matchers with Clang diagnostics, `External Clang Examples`_
may also be useful to look at for examples.

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

https://clang.llvm.org/docs/ExternalClangExamples.html
Expand Down
Loading