hanchenye-llvm-project/clang-tools-extra/docs
Jonas Toth 3f7eb40cdb [clang-tidy] adjust cppcoreguidelines-owning-memory documentation
Summary:
A user of the check opened a bugreport and reported that `std::exchange`
triggers a false positive. I adjusted the doc to include a list of known
(std) constructs that do trigger the issue with templates forgetting the
type alias.

Reviewers: aaron.ballman, alexfh, hokein

Reviewed By: aaron.ballman

Subscribers: klimek, nemanjai, xazax.hun, kbarton, cfe-commits

Differential Revision: https://reviews.llvm.org/D40829

llvm-svn: 319785
2017-12-05 16:37:49 +00:00
..
clang-tidy [clang-tidy] adjust cppcoreguidelines-owning-memory documentation 2017-12-05 16:37:49 +00:00
CMakeLists.txt docs: Fix Sphinx detection with out-of-tree builds 2017-05-09 11:11:52 +00:00
Doxyfile
ModularizeUsage.rst Remove trailing whitespace in docs and clang-tidy sources. 2016-12-13 16:38:45 +00:00
README.txt
ReleaseNotes.rst [Documentation] Style fixes for Objective-C checks documentation to follow C/C++ example. 2017-11-30 21:42:27 +00:00
clang-modernize.rst
clang-rename.rst clang-rename: add new -force option 2017-06-02 09:32:28 +00:00
clang-tidy.rst
clangd.rst [clangd] Cleanup ClangdUnit.cpp, update docs; NFC 2017-06-28 20:57:28 +00:00
conf.py Bump docs version to 6.0 2017-07-19 13:51:07 +00:00
cpp11-migrate.rst
doxygen-mainpage.dox
doxygen.cfg.in [docs] Tell Doxygen to expand LLVM_ALIGNAS to nothing 2017-01-19 13:38:19 +00:00
include-fixer.rst [docs] Remove doubled spaces 2016-11-17 14:26:45 +00:00
index.rst [clangd] Add documentation page 2017-05-04 19:57:53 +00:00
make.bat
modularize.rst [docs] Remove doubled spaces 2016-11-17 14:26:45 +00:00
pp-trace.rst [docs] Remove doubled spaces 2016-11-17 14:26:45 +00:00

README.txt

-------------------------------------------------------------
Documentation for the tools of clang-tools-extra repo project
-------------------------------------------------------------

Sphinx and doxygen documentation is generated by executing make.

Sphinx html files can be generated separately using make html.

Doxygen html files can also be generated using make doxygen.

The generated documentation will be placed in _build/html.