[clang-tools-extra] [clang-tidy] Replace /* ... */ single-line comments with // ... comments (PR #124319)
via cfe-commits
cfe-commits at lists.llvm.org
Sun Feb 2 08:16:35 PST 2025
4m4n-x-B4w4ne wrote:
> As @PiotrZSL mentioned in the issue, adding an option called something like `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:
>
> ```c++
> /**
> * ... text ...
> */
> void foo()
> ```
>
> With this option enabled, I think we should exclude the following cases:
>
> ```c++
> /**
> * ... text ...
> */
>
> /*!
> * ... text ...
> */
>
> /***********************************************
> * ... text
> ***********************************************/
> ```
>
> Basically, they are comments that start with `/*` followed by more than one `*` or start with `/*!` 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.
I have done this can you please check.
https://github.com/llvm/llvm-project/pull/124319
More information about the cfe-commits
mailing list