diff options
| author | albert-github <albert.tests@gmail.com> | 2021-06-08 13:20:07 (GMT) |
|---|---|---|
| committer | albert-github <albert.tests@gmail.com> | 2021-06-08 13:20:07 (GMT) |
| commit | 0000628dae381c5ac156186baf3c2c07eda222e2 (patch) | |
| tree | 55e0904385ded935572247c67e86aa9a8e7a78ce | |
| parent | 8c8a0343662f69ce65ced20dc8c6025e7fc022cd (diff) | |
| download | Doxygen-0000628dae381c5ac156186baf3c2c07eda222e2.zip Doxygen-0000628dae381c5ac156186baf3c2c07eda222e2.tar.gz Doxygen-0000628dae381c5ac156186baf3c2c07eda222e2.tar.bz2 | |
issue #8591 Doxygen comment suggestion in help collides with clang-format
Added a general warning about the `/****//**` type of comment
| -rw-r--r-- | doc/docblocks.doc | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/docblocks.doc b/doc/docblocks.doc index 92bf3df..8ccb08c 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -113,7 +113,10 @@ documentation. For this purpose you can use the following: * ... text ***********************************************/ \endverbatim -(note the 2 slashes to end the normal comment block and start a special comment block). +Note: the 2 slashes to end the normal comment block and start a special comment block. + +Note: be careful when using a reformatter as a reformatter can see this type of comment +as 2 separate comments resulting in non expected comment formatting. or |