Magic-Mirror/llvm-capstone
1
0
Fork 0
mirror of https://github.com/capstone-engine/llvm-capstone.git synced 2025-01-05 23:52:45 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
4134143cf5
llvm-capstone/clang-tools-extra/docs
History
Paul Hoad 6bfd721571 [clang-tidy] Add options to bugprone-argument-comment to add missing argument comments to literals 
bugprone-argument-comment only supports identifying those comments which do not match the function parameter name

This revision add 3 options to adding missing argument comments to literals (granularity on type is added to control verbosity of fixit)

```
CheckOptions:
  - key:             bugprone-argument-comment.CommentBoolLiterals
    value:           '1'
  - key:             bugprone-argument-comment.CommentFloatLiterals
    value:           '1'
  - key:             bugprone-argument-comment.CommentIntegerLiterals
    value:           '1'
  - key:             bugprone-argument-comment.CommentStringLiterals
    value:           '1'
  - key:             bugprone-argument-comment.CommentCharacterLiterals
    value:           '1'
  - key:             bugprone-argument-comment.CommentUserDefinedLiterals
    value:           '1'
  - key:             bugprone-argument-comment.CommentNullPtrs
    value:           '1'
```

After applying these options, literal arguments will be preceded with /*ParameterName=*/

Reviewers: JonasToth, Eugene.Zelenko, alexfh, hokein, aaron.ballman

Reviewed By: aaron.ballman, Eugene.Zelenko

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

llvm-svn: 353535
2019-02-08 17:00:01 +00:00
..
clang-tidy [clang-tidy] Add options to bugprone-argument-comment to add missing argument comments to literals 2019-02-08 17:00:01 +00:00
clang-doc.rst [Documentation] Use HTTPS whenever possible. 2019-01-22 19:19:48 +00:00
clang-modernize.rst
clang-rename.rst Adjust documentation for git migration. 2019-01-29 16:37:27 +00:00
clang-tidy.rst [Documentation] Use HTTPS whenever possible. 2019-01-22 19:19:48 +00:00
clangd.rst [clangd] Mention indexing in docs. 2019-02-07 16:10:39 +00:00
CMakeLists.txt
conf.py Bump the trunk version to 9.0.0svn 2019-01-16 10:57:02 +00:00
cpp11-migrate.rst
doxygen-mainpage.dox
doxygen.cfg.in [clang-tools-extra] Cleanup documentation routine 2018-07-04 10:18:03 +00:00
include-fixer.rst [Documentation] Use HTTPS whenever possible. 2019-01-22 19:19:48 +00:00
index.rst [docs] Adding clang-doc to CTE toctree to fix docs build error 2018-03-12 21:39:01 +00:00
make.bat
modularize.rst [Documentation] Use HTTPS whenever possible. 2019-01-22 19:19:48 +00:00
ModularizeUsage.rst
pp-trace.rst [Documentation] Use HTTPS whenever possible. 2019-01-22 19:19:48 +00:00
README.txt
ReleaseNotes.rst [clang-tidy] Add options to bugprone-argument-comment to add missing argument comments to literals 2019-02-08 17:00:01 +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.