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
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

Reply via email to