[clang-tools-extra] [clang-tidy] Replace /* ... */ single-line comments with // ... comments (PR #124319)
Baranov Victor via cfe-commits
cfe-commits at lists.llvm.org
Mon Jan 27 11:43:33 PST 2025
vbvictor wrote:
As @PiotrZSL mentioned in the issue, adding an option called `ExcludeDoxygenStyleComments` would be very helpful (or even necessary) before releasing this check. Otherwise, it could create a lot of trouble for projects that use doxygen for their documentation (including LLVM itself).
Doxygen comments typically look like this:
```cpp
/**
* ... text ...
*/
void foo()
```
With this option enabled, I think we should exclude the following cases:
```cpp
/**
* ... text ...
*/
/*!
* ... text ...
*/
/***********************************************
* ... text
***********************************************/
```
Basically, they are comments that start with `/*` followed by more than one `*` or `/*!`
More detailed documentation can be found in https://www.doxygen.nl/manual/docblocks.html.
This option can also be tested on LLVM codebase for false positives.
https://github.com/llvm/llvm-project/pull/124319
More information about the cfe-commits
mailing list