llvm / llvm-project

The LLVM Project is a collection of modular and reusable compiler and toolchain technologies.
http://llvm.org
Other
28.75k stars 11.89k forks source link

Missing documentation for some Clang Static Analyzer checks #64614

Open PiotrZSL opened 1 year ago

PiotrZSL commented 1 year ago

In file clang/include/clang/StaticAnalyzer/Checkers/Checkers.td following checks are listed, but no such documentation exists in clang/docs/analyzer/checkers.rst:

Looks like property Documentation cannot be trusted, as there are checks marked as HasDocumentation without documentation, and those marked as NotDocumented with documentation (osx.ObjCProperty for example).

clang-tools-extra/docs/clang-tidy/checks/gen-static-analyzer-docs.py should be executed after adding documentation to update aliases on Clang-tidy side.

llvmbot commented 1 year ago

@llvm/issue-subscribers-clang-static-analyzer