Skip to content
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

Missing documentation for some Clang Static Analyzer checks #64614

Open
PiotrZSL opened this issue Aug 11, 2023 · 1 comment
Open

Missing documentation for some Clang Static Analyzer checks #64614

PiotrZSL opened this issue Aug 11, 2023 · 1 comment

Comments

@PiotrZSL
Copy link
Member

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

  • cplusplus.Move
  • cplusplus.PlacementNew (invalid name in documentation, see: https://reviews.llvm.org/D157702)
  • cplusplus.PureVirtualCall
  • optin.osx.OSObjectCStyleCast (marked as NotDocumented)
  • osx.MIG (marked as NotDocumented)
  • osx.OSObjectRetainCount (marked as NotDocumented)
  • security.insecureAPI.decodeValueOfObjCType
  • valist.CopyToSelf
  • valist.Uninitialized
  • valist.Unterminated

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
Copy link
Collaborator

llvmbot commented Aug 11, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants